Conventions and Guidelines (WIP)¶

Issue Management¶

Code Contributions (Commits)¶

Linking Commits to Issues¶

• Every commit must be linked to an issue, i.e. in each commit use the key word Re #<issue-no>. Alternatively, you can use the key word refs #<issue1-no>, #<issue2-no>, although it is preferable for each commit to be linked with exaclty one issue.
• If you think your commit is not related to any existing issue, link it to the "Refactoring" issue (such issue will be prepared for every iteration).
• It is preferable for the keyword(s) to appear at the very beginning of a commit message. ????
  chceme i jiny nez re a refs ?????

Note.: The keywords are caseinsensitive and at least one blankspace or colon is needed between the keyword and the first hash to produce a match (taken from Redmine doc).

Commit messages¶

Every commit must have a commit message briefly explaining what the changes in the commit do.

End of Iteration tags
????¶

Coding and Code Documentation¶

When coding, use the generally known best practices (whether they are related to the used language or not), e.g.:
https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions

• Use reasonable variable names
• Comment the code

• Use documentation comments for classes and methods (see https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/documentation-comments)
• Use in-code comments too - the rules for this aren't strict, but try to comment every line/block of code, which might be even a little unclear to the reader

Wiki Documentation¶