Improve contribution documentations and add templates #816
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
docs/pull_request_template.md
Outdated
|
|
||
| # How has this been tested? | ||
|
|
||
| Please describe the tests that you wrote to verify your changes. //FIXME: Do we want this? |
There was a problem hiding this comment.
Since in doubt, we could remove this for the moment, and add something about How has this been tested? when we feel the need.
Usually tests should already be clear enough to be understood without much extra description, if some extra information is needed I'd see acceptable having that extra context in the description.
wdyt?
There was a problem hiding this comment.
Most of these can be implemented as checks in the CI, but some of them I find them at least valuable to maybe be included in the CONTRIBUTING.md
There was a problem hiding this comment.
Good, what is your proposal instead of the FIXME 😄 ?
dottorblaster
approved these changes
Sep 23, 2022
nelsonkopliku
approved these changes
Sep 23, 2022
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.
In order to make contributions (and reviewing them) easier, this PR:
CONTRIBUTING.mdfile to include some suggestions on PRs, reviews and issues