Clement Tsang
747497cc8a
Fixes a broken link, and mention when to use discussions over issues. Also updates mkdocs in the build process due to some broken dependencies.
2.1 KiB
Issues, Pull Requests, and Discussions
Contribution in any way is appreciated, whether it is reporting problems, fixing bugs, implementing features, improving the documentation, etc.
Discussions
Discussions are open in the repo. As for the difference between discussions and issues:
- Open an issue if what you have enough information to properly fill out any details needed for a report or request.
- Open a discussion otherwise (e.g. asking a question).
Opening an issue
Bug reports
When filing a bug report, please use the bug report template and fill in as much as you can. It is incredibly difficult for a maintainer to fix a bug when it cannot be reproduced, and giving as much detail as possible generally helps to make it easier to reproduce the problem!
Feature requests
Please use the feature request template and fill it out. Remember to give details about what the feature is along with why you think this suggestion will be useful.
Also please check whether or not an existing issue has covered your specific feature request!
Pull requests
The expected workflow for a pull request is:
- Fork the project.
- Make your changes.
- Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes. See here for tips on documentation.
- Commit and create a pull request to merge into the
masterbranch. Please follow the pull request template. - Wait for the tests to pass. These consist of clippy lints, rustfmt checks, and basic tests. If you are a first time contributor, you may need to skip this step for now, as GitHub Actions requires approval to run.
- Ask a maintainer to review your pull request. If changes are suggested or any comments are made, they should probably be addressed. Once it looks good, it'll be merged!