Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove copyright and author in java files? #633

Open
renedupont opened this issue Nov 17, 2020 · 3 comments
Open

Remove copyright and author in java files? #633

renedupont opened this issue Nov 17, 2020 · 3 comments
Labels
question Further information is requested

Comments

@renedupont
Copy link
Member

Is your feature request related to a problem? Please describe.
I noticed that many java files have a huge text at the beginning regarding Copyright and also an author annotation above the class name.
I want to raise and discuss the question if these copyright mantras are really necessary there, because if not I'd see them as a huge chunk of code noise.
Regarding the author annotation I share the opinion of https://www.vojtechruzicka.com/stop-using-javadoc-author-tag/#what-is-wrong-with-author and would remove them altogether. Any objections to this?

Describe the solution you'd like
Remove author annotations. Clearify if copyright text can also go away.

Describe alternatives you've considered
Leave it like it is.

@renedupont renedupont added the question Further information is requested label Nov 17, 2020
@stitakis
Copy link
Member

@michaelsauter @clemensutschig do you know why the copyright header was added to the prov app classes? Can we remove the copyright header? How do we handle copyright in ods?

@michaelsauter
Copy link
Member

Sorry I don't know - would need to look into what is required or not.

@renedupont
Copy link
Member Author

renedupont commented Dec 11, 2020

The author annotations were removed by PR #639.
I read a bit about the copyright notice and I am still not 100% sure about this, but for a project there is the LICENCE.md file which we also have, but that it could also make sense to put a notice in each file for cases where people take only parts (or files) of the project. I looked at the google guava lib on github as an example and they have both, a LICENCE.md file and a notice in every source code file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants