diff options
| author | Steve Winslow <swinslow@gmail.com> | 2019-03-06 09:12:54 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-03-06 09:12:54 -0500 |
| commit | 3dcceb5b869ab2f6a58ce8198aa5213614609e09 (patch) | |
| tree | 08443ddd0b42ebb141e0e74cc4957efef240ea03 /CONTRIBUTING.md | |
| parent | 99ae167d509143d1526f395af72ea80731be7417 (diff) | |
| download | spdx-tools-3dcceb5b869ab2f6a58ce8198aa5213614609e09.tar.gz | |
Add notes on test coverage
Signed-off-by: Steve Winslow <swinslow@gmail.com>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 225f872..48c6eb8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: |