Conventions and Guidelines » Historie » Verze 1
Eliška Mourycová, 2021-04-17 06:56
| 1 | 1 | Eliška Mourycová | h1. Conventions and Guidelines (WIP) |
|---|---|---|---|
| 2 | |||
| 3 | h2. Issue Management |
||
| 4 | |||
| 5 | |||
| 6 | h2. Code Contributions (Commits) |
||
| 7 | |||
| 8 | h3. Linking Commits to Issues |
||
| 9 | |||
| 10 | * 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. |
||
| 11 | * 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). |
||
| 12 | * It is preferable for the keyword(s) to appear at the very beginning of a commit message. ?????? |
||
| 13 | chceme i jiny nez re a refs ??????? |
||
| 14 | |||
| 15 | 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). |
||
| 16 | |||
| 17 | h3. Commit messages |
||
| 18 | |||
| 19 | Every commit must have a commit message briefly explaining what the changes in the commit do. |
||
| 20 | |||
| 21 | |||
| 22 | h3. End of Iteration tags |
||
| 23 | ???? |
||
| 24 | |||
| 25 | |||
| 26 | h2. Coding and Code Documentation |
||
| 27 | |||
| 28 | When coding, use the generally known best practices (whether they are related to the used language or not), e.g.: |
||
| 29 | https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/inside-a-program/coding-conventions |
||
| 30 | |||
| 31 | |||
| 32 | * Use reasonable variable names |
||
| 33 | * Comment the code |
||
| 34 | > * Use documentation comments for classes and methods (see https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/documentation-comments) |
||
| 35 | > * 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 |
||
| 36 | |||
| 37 | h2. Wiki Documentation |