Skip to content

Commit

Permalink
Add notes on test coverage
Browse files Browse the repository at this point in the history
Signed-off-by: Steve Winslow <swinslow@gmail.com>
  • Loading branch information
swinslow committed Mar 6, 2019
1 parent 99ae167 commit 3dcceb5
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ All contributions must include a "Signed-off-by" line in the commit message.

This indicates that the contribution is made pursuant to the [Developer Certificate of Origin (DCO)](https://developercertificate.org/), a copy of which is included below.

## Test coverage

Since this library is intended to be relied upon by other tools to work with SPDX data, we are aiming to ensure that it is and remains well-tested.

PRs with new code should include corresponding test files, and should continue to pass existing tests. Unit tests for `foo.go` should be placed in `foo_test.go`. Test data files and folders should be placed in the top-level `testdata/` folder.

To run the test suite, from the top-level directory run: `go test ./v0/...`

## License information

New **code files** should include a [short-form SPDX ID](https://spdx.org/ids) at the top, indicating the project license for code, which is Apache-2.0 OR GPL-2.0-or-later. This should look like the following:
Expand Down

0 comments on commit 3dcceb5

Please sign in to comment.