Move maintainers guide into CONTRIBUTING.md and add PR templates #217
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
Removed release steps on manually testing before a release because CI handles these tests automatically. Release guide now suggests making a PR for updates and using the tests from those. Removed mention of `make doctest`. Whatever tools this relied on were never set up. Nothing was in the doc directory to be tested. Release guide no longer suggests adding a signature.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #217 +/- ##
=======================================
Coverage 96.95% 96.95%
=======================================
Files 15 15
Lines 1282 1282
=======================================
Hits 1243 1243
Misses 39 39 ☔ View full report in Codecov by Sentry. |
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.
I keep having to repeat myself in PR's since I never got around to making a PR template. I've now added a PR checklist for the most important topics. Relevant for #125
I've updated the
CONTRIBUTING.mdfile with more guidelines. Some of these might be opinionated, but it's mostly stuff I've talked about in PR's or thought of talking about.The doc directory only included the release guide. I've merged this into
CONTRIBUTING.mdwhich is a more appropriate place for that kind of documention. This removes the doc directory since there are no more files left in it.Removed release steps on manually testing before a release because CI handles these tests automatically. Release guide now suggests making a PR for updates and using the tests from those.
Removed mention of
make doctest. Whatever tools this relied on were never set up. Nothing was in the doc directory to be tested.Release guide no longer suggests adding a signature. The idea of signatures being useful in this context is outdated. See #196 for a more realistic way of making releases more secure.