Update the Contributors Guide #310
Description
The contributors guide (CONTRIBUTING.md) needs a refresh to include more details to help less experienced contributors. This is a great first issue if you are new to open source.
How to help
- Look at the list below and choose a section to work on (the checkbox indicates if someone already started working on it).
- Add a comment to the issue, saying which section you are planning to work on. If you are working on a conference sprint, mention it!)
- You can find more details about the contents of each section in the guide itself (look for
*__TODO__:labels) - Once you are done, submit a pull request!
Sections should be short (one or two paragraphs) and you should assume the reader is not very familiar with the open source development process. Feel free to include code blocks and images as necessary!
Sections that need work
In the section Forking the repository:
- Forking the repository
In the section Contributing via the GitHub website:
- How to edit a MarkDown file
- How to commit your changes (in the section
In the section Contributing locally on your computer
- Clone your forked repository
- Clone your forked repository
- Create a new branch
- Create a virtual environment
- Install the development dependencies
- Commit your changes
- How to build the guide locally
- Before you submit your pull request
In the section Submitting a pull request with your contribution
- How to make a pull request
- What happens when you submit a pull request (CI/CD)
- What to expect from the review process
The section Additional help
- How to get help
- Useful resources