]> git.lizzy.rs Git - nothing.git/blob - CONTRIBUTING.md
Merge pull request #505 from tsoding/108
[nothing.git] / CONTRIBUTING.md
1 # Issues
2
3 - Feel free to submit an issues in case of
4   - bug
5   - suggestion
6   - feature request
7   - question regarding the project
8   - unclear documentation
9   - unreadable or straight up bad code
10   - any problem that you ran into while setting up the project on your side
11 - Do not submit **Tasks**. Submit **Problems**.
12   - Bad issue: "Rewrite everything in Rust"
13   - Good issue: "Using C makes the development difficult"
14   - We are engineers. We don't follow anybody's direction. We solve problems. Please submit problems.
15
16 # Pull Requests
17
18 - Keep your PRs nice and small around 300 changes. PRs that are way over that threshold won't be merged.
19   - If 300 changes is not enough,
20     - make as many changes as you can according to the PR size limitation,
21     - make sure that the code is compilable and the application is usable,
22     - create TODOs right in the code for the unfinished work,
23     - submit PR with the unfinished work and TODOs,
24     - TODOs will be converted to separate issues