Add Parcels versioning/deprecation policies and maintainer docs #1696
Conversation
This file contains hidden or 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
Codecov ReportAll modified and coverable lines are covered by tests ✅ Additional details and impacted files@@ Coverage Diff @@
## master #1696 +/- ##
=======================================
Coverage 81.18% 81.18%
=======================================
Files 72 72
Lines 13256 13256
Branches 127 127
=======================================
Hits 10762 10762
Misses 2457 2457
Partials 37 37
Flags with carried forward coverage won't be shown. Click here to find out more. |
- create community index page - add policy docs - update contributing page - add maintainer notes
23d3eec to
b894e10
Compare
e2f8cc1 to
1c06d84
Compare
3a441c4 to
4aba624
Compare
Contributor
Author
|
I'm also finding the coverage bot comments on every PR slightly annoying. Perhaps worth disabling? Other projects have the bot texting in a Gitter/Slack channel (which we don't have, and they don't support teams). I don't mind just checking the codecov page directly |
Member
Yes agree that we don't need codecov messages in each PR |
erikvansebille
approved these changes
Sep 11, 2024
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.
Fixes #1681, fixes #1688 and other minor changes
New pages:
Note that this PR specifies
indicating that the next release of Parcels will be v3.1.0. Even if we don't add any new features, the deprecation policy mentions that deprecations are done between minor releases (e.g., v3.x.0) while patch releases (e.g., v3.0.x) are reserved for minor changes like bug fixes or usability improvements.
In terms of organisation, Sphinx works better with a directory layout (as opposed to a flat layout with individual pages, which is what we currently have). The dir layout allows Sphinx to better build the toc trees, which I think is better for the longterm. As such, this PR will change the link to our contributing guidelines and go from
.../latest/contributing.htmlto.../latest/community/contributing.html. I have added a redirect so users with the old link/latest/contributing.htmlgo to the updated page.I have also updated RTD to now point back to
latestinstead of the tagged release.