Skip to content

Commit

Permalink
Complete sentence on tests.
Browse files Browse the repository at this point in the history
  • Loading branch information
vgvassilev authored Jun 3, 2024
1 parent 07d6f3d commit 9579ce4
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,8 @@ review quickly and successfully share several common traits:
description mentions `Fixes: #<ISSUE_NUMBER>`. That will link both and will
close the issue automatically upon merging.
- Tested -- has a set of tests making sure that the issue will not resurface
without a notice. Usually
without a notice. Usually the codecov bots annotate the code paths that are
not tested in the pull request after being run.
- Documented -- has good amount of code comment. The test cases are also a good
source of documentation. [Here](https://stackoverflow.blog/2021/12/23/best-practices-for-writing-code-comments/)
is a guideline about how write good code comments. [Here](https://stackoverflow.com/questions/184618/what-is-the-best-comment-in-source-code-you-have-ever-encountered)
Expand Down

0 comments on commit 9579ce4

Please sign in to comment.