CONTRIBUTING.md

   1 # Roles
   2
   3 ## Project Leader
   4
   5 Current Project Leader: [@rexim]
   6
   7 - Project Leader is fully responsible for the project.
   8 - If something doesn't work blame Project Leader for that. Not the Contributor who introduced a bug. If the Project Leader did their job well they would not accept the changes in the first place.
   9 - Project Leader defines these rules and their interpretation.
  10
  11 ## Contributor
  12
  13 Contributors are welcome to submit Issues and Pull Requests according to the rules below. If the rules are not clear, ask the Project Leader on what to do in any particular situation.
  14
  15 ### Issues
  16
  17 - Feel free to submit an issues in case of
  18   - bug
  19   - suggestion
  20   - feature request
  21   - question regarding the project
  22   - unclear documentation
  23   - unreadable or straight up bad code
  24   - any problem that you ran into while setting up the project on your side
  25 - Do not submit **Tasks**. Submit **Problems**.
  26   - Bad issue: "Rewrite everything in Rust"
  27   - Good issue: "Using C makes the development difficult"
  28   - We are engineers. We don't follow anybody's direction. We solve problems. Please submit problems.
  29
  30 ### Pull Requests
  31
  32 - Keep your PRs nice and small around 300 changes (including adding new lines). PRs that are way over that threshold won't be merged. Exceptions may apply if the reasons for a bigger PRs are communicated properly to the Project Leader in the description of the Pull Request.
  33   - If 300 changes is not enough,
  34     - make as many changes as you can according to the PR size limitation,
  35     - make sure that the code is compilable and the application is usable,
  36     - create TODOs right in the code for the unfinished work,
  37     - submit PR with the unfinished work and TODOs,
  38     - TODOs will be converted to separate issues
  39 - Neglected PRs older than two weeks may be closed by Project Leader at any time.
  40 - 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.
  41
  42 [@rexim]: https://github.com/rexim