-
Notifications
You must be signed in to change notification settings - Fork 371
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
Update coding standards #1267
Update coding standards #1267
Conversation
853a344
to
b5779a4
Compare
b5779a4
to
3aa9ea1
Compare
No more pre-amble year updates 🎉. Rather than add a commit that changes every single file I suggest we update these as we go, which means we will see failures as we update files, but we won't be obliged to to this annually. |
🎉 |
I was just going through some people's PRs and noticed that a lot of CI failures were because of the copyright header year not being updated. It looks like from the discussion above,
does this imply that the year in each source file isn't needed, but rather just a reference to the main LICENSE file in the base of the repo? I also noticed that the updates here removed the Crown Copyright and changed it to Cartopy Contributors, but all of the source files still contain the Crown Copyright. I'm wondering if this should all be updated in the main LICENSE file to something along the lines of Crown Copyright 2011 - 2018, Cartopy Contributors 2019 - 2020 indicating when you made the switch? This is all to say that I have no experience with legal-speak, and am just looking to avoid only finding the copyright failure on CI when all other checks have passed locally. |
I believe both headers are allowed (see the license header test) to allow for piecemeal conversion. It just hasn't really been done on most files.
|
Thanks, @QuLogic! I must have been doing something funky in my directory to not be running it. I see it is getting called in pytest for me locally now. |
I was going to wait until Jan 2020 to get rid of the years altogether, but turned out things got a bit busy 😄 From a LICENSE file perspective, technically we can say that all of the contributions to cartopy are copyright "Cartopy contributors". To be explicit, I recommend all future updates to the headers remove years as supported by this PR so that we never have this silly situation where we are making unnecessary commits because of some arbitrary date. |
Rationale
The test_coding_standards test now reflects SciTools/scitools.org.uk#209 without needing a wholesale change to all files in the cartopy codebase.
Specifically the year does not need to be part of the header, and the full license details can be referenced rather than explicit.
Implications
__init__.py
) no longer need a license header nor the special future imports tested for in test_coding_standards.TODO: