54 lines
2 KiB
Markdown
54 lines
2 KiB
Markdown
|
# Contributing to [Project]
|
|||
|
|
|
|||
|
|
Thank you for considering to contribute to our project!
|
|||
|
|
|
|||
|
|
There’s many ways you can help us:
|
|||
|
|
|
|||
|
|
## Issues
|
|||
|
|
|
|||
|
|
Issues are very valuable both for reporting bugs and for gathering feedback on where the project is lacking. Before creating them, please try to find if someone else has already reported the issue, and upvote that instead.
|
|||
|
|
|
|||
|
|
## Pull Requests
|
|||
|
|
|
|||
|
|
Pull requests are always welcome! We'll do our best to review your pull request as soon as possible. Please make sure you follow these guidelines:
|
|||
|
|
|
|||
|
|
1. The pull request needs to make the intent of it clear.
|
|||
|
|
|
|||
|
|
GOOD: Allow `Component` to persist state.
|
|||
|
|
|
|||
|
|
BAD: Implement `Serialize` and `Deserialize` on `Component`
|
|||
|
|
2. If it includes new code or fixes a bug, it should include tests. These do not need to be exhaustive.
|
|||
|
|
3. Public APIs need to be documented.
|
|||
|
|
4. The Pull Request needs to pass all CI tests.
|
|||
|
|
5. Unless the change only affects documentation or tests, add a corresponding line to the [changelog](./CHANGELOG.md)
|
|||
|
|
|
|||
|
|
By creating a pull request on our repository, you agree to the [Developer Certificate of Origin](https://developercertificate.org/).
|
|||
|
|
|
|||
|
|
## Documentation
|
|||
|
|
If you find parts of the documentation lacking, you are always welcome to extend or rewrite it.
|
|||
|
|
|
|||
|
|
## Tests
|
|||
|
|
We try to uncover issues in the code automatically before they are released. To facilitate this, we need plenty of tests. For this, tests that automatically test edge cases are welcome as well.
|
|||
|
|
|
|||
|
|
## Translations
|
|||
|
|
[TODO: We do not have a weblate]
|
|||
|
|
|
|||
|
|
## Testing
|
|||
|
|
|
|||
|
|
You can also help by running prerelease versions and reporting bugs and issues with them.
|
|||
|
|
|
|||
|
|
## Assisting
|
|||
|
|
|
|||
|
|
You can also contribute by helping others in the chatrooms, or by posting blog articles about using the project.
|
|||
|
|
|
|||
|
|
## Code of Conduct
|
|||
|
|
|
|||
|
|
Please follow the (Code of Conduct)[./CODE-OF-CONDUCT.md] in all correspondence with this project.
|
|||
|
|
|
|||
|
|
## Security Review
|
|||
|
|
|
|||
|
|
If you find a security issue, please look at our (Security Policy)[./SECURITY.md]
|
|||
|
|
|
|||
|
|
## Donations
|
|||
|
|
|
|||
|
|
You can donate money to the project maintainer here: https://ko-fi.com/darkkirb
|