Skip to content
This repository was archived by the owner on May 27, 2024. It is now read-only.

Spec: Add a statement at the start clarifying that a comment header in every file is preferable #25

Closed
carmenbianca opened this issue May 28, 2019 · 4 comments

Comments

@carmenbianca
Copy link
Member

Thread: #23 (comment)

Relevant section:

This specification defines a standardized method for declaring copyright and
licensing for software projects. The goal of the specification is to have
unambiguous, machine-readable copyright and licensing information for each
individual file in a project.

@silverhook

Perhaps also add why we the aim is to have license info in every file.

@carmenbianca

I'm sorry I don't understand well enough what you mean here.

@mxmehl

I think @silverhook means that there is a big benefit of having copyright information in the files, not somewhere else like a DEP-5 file, because they will retain even if just a single file is copied from a project. Right?

@silverhook

Yes, that’s exactly what I meant with that suggestion.

@carmenbianca
Copy link
Member Author

I'm not sure if this is needed per se in the preamble of the spec. The spec itself already makes a clear recommendation of comment headers over DEP5. But here would be my suggestion:

This specification defines a standardized method for declaring copyright and
licensing for software projects. The goal of the specification is to have
unambiguous, machine-readable copyright and licensing information for each
individual file in a project. Ideally this information is embedded into every file,
so that the information is preserved when the file is copied and reused by third
parties.

@mxmehl
Copy link
Member

mxmehl commented Jun 3, 2019

LGTM, thanks!

@silverhook
Copy link
Collaborator

LGTM. Perhaps we should expand it to say “machine- and human-readable copyright and licensing information”.

@carmenbianca
Copy link
Member Author

Added in d85fe57

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants