Simplify logic and allow any SPDX header by default #22
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
As a user, I found the inclusion of _author_ confusing, and I had to check the code to see how it gets included. I think it might be simpler if the regex is the only parameter. There is a common recommendation to just list the authors as "The Authors" or "Contributors to <Project>" anyway, both for legal reasons (sometimes who actually holds the copyright would be decided in court), because lots more people than the authors could hold part of the copyright, because you'd have to update the header if the authors change, and because it's not necessary. While I was at it, I also set the default min length to 1024, closed the open file handle, dropped the unnecessary encoding header, and included any `SPDX-` header in the default regex.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As a user, I found the inclusion of author confusing, and I had to check the code to see how it gets included. I think it might be simpler if the regex is the only parameter. There is a common recommendation to just list the authors as "The Authors" or "Contributors to " anyway, both for legal reasons (sometimes who actually holds the copyright would be decided in court), because lots more people than the authors could hold part of the copyright, because you'd have to update the header if the authors change, and because it's not necessary.
While I was at it, I also set the default min length to 1024, closed the open file handle, dropped the unnecessary encoding header, and included any
SPDX-header in the default regex.