- Feel free to submit an issues in case of
- bug
- suggestion
- feature request
- question regarding the project
- unclear documentation
- unreadable or straight up bad code
- any problem that you ran into while setting up the project on your side
- Do not submit Tasks. Submit Problems.
- Bad issue: "Rewrite everything in Rust"
- Good issue: "Using C makes the development difficult"
- We are engineers. We don't follow anybody's direction. We solve problems. Please submit problems.
- If you see any issues that look like tasks, feel free to point that out in the comments.
- Make sure the CI is passed.
- Keep your PRs nice and small around 300 changes. PRs that are way over that threshold won't be merged.
- If 300 changes is not enough,
- make as many changes as you can according to the PR size limitation,
- make sure that the code is compilable and the application is usable,
- create TODOs right in the code for the unfinished work (format your TODOs according to the Snitch TODO format),
- submit PR with the unfinished work and TODOs,
- after the merge TODOs will be converted to separate issues by the Project Leader (@rexim as of now),
- If 300 changes is not enough,
- If you fix a bug, please don't forget to create a Unit Test that fails without your fix.
- Neglected PRs older than two weeks are gonna be automatically closed.
- Don't get discouraged if your PR was not merged. The Rules and CI are designed to keep the quality of the code high so you don't have to worry about it yourself. Keep experimenting, keep improving.