Extend CONTRIBUTING docs. #153
Merged
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
Closed
6 tasks
jlprat
approved these changes
Oct 26, 2022
Co-authored-by: Josep Prat <[email protected]>
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.
About this change - What it does
Adds more detail on how to contribute.
The doc tries to answer following questions:
Resolves: #99
Why this way
Since we don't have a more strict set of rules yet, I tried to keep it a bit more open while still providing a guideline for people who would want to contribute. I thought about adding some examples like I did with the commit messages, but decided we can do that later and than e.g. link a pull request as example etc.
In general I tried to create a "voice" that is welcoming and makes it clear that every contribution is welcome! The text should provide a good entry point to contribute. I also wanted it to provide a kind of checklist, so people don't have (too much) uncertainty around how they should create issues or pull requests.