First of all, thank you for contributing to Sanoid!
This document provides guidelines for contributing to the project. They are written to ensure its consistency and maintainability. All contributions are welcome, as long as you follow these guidelines. If you have any questions, please contact me.
There are many ways to contribute to the project, including, but not limited to, submitting bug reports and feature requests, improving documentation or writing code.
Bug reports are hugely important, but please make sure to avoid duplicate reports. Before you submit one, please check Sanoid issues, both open and closed, and make sure, that the bug has not been reported before.
When filing an issue, include answers to the following five questions:
- What version of Sanoid are you using?
- What did you do?
- What was the expected result?
- What was the actual result?
If you have a suggestion for a feature or an enhancement, please feel free to open an issue. In your feature request, include the following:
- What should the feature do?
- Why do you need it?
- How should it work?
Note that I reserve a right to reject a feature request, if I feel it does not align with the project's goals.
If this is your first time contributing code look at How to create a merge request. After you read it, you follow this checklist to make a merge request:
- Fork the repository.
- Install pre-commit hooks via
pre-commit install. - Add your feature.
- Make a merge request.
- Write your commit message in the imperative: "Fix bug" and not "Fixed bug" or "Fixes bug." This convention matches up with commit messages generated by commands like git merge and git revert.
If you have found any mistakes, want to add examples, or just improve the documentation in general, you are more than welcome! Just make your change and send a merge request.
Thank you for taking the time to read the Contributor's Guide!
Radek Sprta
Maintainer