- Use English.
- Place helper scripts in
scripts
directory. - Place documentation in
docs
directory if it is project-wide doc or in<program-name>/docs
, e.g.cc/docs
if it is program-wide one. - Write documentation in Markdown where possible.
- Write code compliant with C# Coding Conventions.
- Make issues for every task that needs to be done in a project.
- Remember to take care of an issue on a board (moving issues between To do, In progress, etc.).
- Name your branches after issue names with kebab-case, e.g. issue named
"Network node program specification and architecture" will have a branch
"
network-node-program-specification-and-architecture
". - All commit messages must have issue number before anything else, e.g.
"
#7 Fix logs not being present in logfiles
". This is checked in a pre-commit hook. - All commit messages need to be in imperative mode, so "
#2 Add ...
", NOT "#2 Added ...
" - DO NOT commit directly to
master
branch. This way there is no pull request and no code review, so mistakes are far more likely to happen.