Skip to content

Commit

Permalink
docs: Add some comments about untested code
Browse files Browse the repository at this point in the history
Signed-off-by: Matthew Sykes <[email protected]>
  • Loading branch information
sykesm authored and ryjones committed Mar 18, 2021
1 parent fd72843 commit fffb2bf
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion docs/source/style-guides/go-style.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,13 @@ Testing

Unit tests are expected to accompany all production code changes. These tests
should be fast, provide very good coverage for new and modified code, and
support parallel execution.
support parallel execution (``go test -p``).

We rely heavily on our tests to catch regressions and behavior changes. If code
is not exercised by tests, it will likely be removed. That said, we know there
are some areas of the code where we lack test coverage. If you need to make a
change in one of these areas, tests to cover the impacted paths should be made
before delivering features or fixes.

Two matching libraries are commonly used in our tests. When modifying code,
please use the matching library that has already been chosen for the package.
Expand Down

0 comments on commit fffb2bf

Please sign in to comment.