Skip to content

Commit 9da99da

Browse files
kolyshkinpcmoore
authored andcommitted
docs: dedup README.md and CONTRIBUTING.md
README.md contains some information about testing the library, also there are some notes about it in CONTRIBUTING.md. It seems the relevant text in README better reflects the reality ("make check" performs both linting and testing, it is sufficient, and it requires golangci-lint), so let's use it and drop the other. In other words: - replace the testing note in CONTRIBUTING with the ones from README; - in README, add a reference to CONTRIBUTING. Signed-off-by: Kir Kolyshkin <[email protected]> Acked-by: Tom Hromatka <[email protected]> [PM: cleaned up subject line, removed inline changelog, longline fixes] Signed-off-by: Paul Moore <[email protected]>
1 parent 86fcde9 commit 9da99da

File tree

2 files changed

+11
-26
lines changed

2 files changed

+11
-26
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,23 @@
1-
How to Submit Patches to the libseccomp Project
1+
How to Submit Patches to the libseccomp-golang Project
22
===============================================================================
33
https://github.com/seccomp/libseccomp-golang
44

55
This document is intended to act as a guide to help you contribute to the
6-
libseccomp project. It is not perfect, and there will always be exceptions
7-
to the rules described here, but by following the instructions below you
8-
should have a much easier time getting your work merged with the upstream
6+
libseccomp-golang project. It is not perfect, and there will always be
7+
exceptions to the rules described here, but by following the instructions below
8+
you should have a much easier time getting your work merged with the upstream
99
project.
1010

1111
## Test Your Code Using Existing Tests
1212

13-
There are two possible tests you can run to verify your code. The first
14-
test is used to check the formatting and coding style of your changes, you
15-
can run the test with the following command:
16-
17-
# make check-syntax
18-
19-
... if there are any problems with your changes a diff/patch will be shown
20-
which indicates the problems and how to fix them.
21-
22-
The second possible test is used to ensure the sanity of your code changes
23-
and to test these changes against the included tests. You can run the test
24-
with the following command:
13+
A number of tests and lint related recipes are provided in the Makefile, if
14+
you want to run the standard regression tests, you can execute the following:
2515

2616
# make check
2717

28-
... if there are any faults or errors they will be displayed.
18+
In order to use it, the 'golangci-lint' tool is needed, which can be found at:
19+
20+
* https://github.com/golangci/golangci-lint
2921

3022
## Add New Tests for New Functionality
3123

README.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,6 @@ Documentation for this package is also available at:
3636

3737
# go get github.com/seccomp/libseccomp-golang
3838

39-
## Testing the Library
39+
## Contributing
4040

41-
A number of tests and lint related recipes are provided in the Makefile, if
42-
you want to run the standard regression tests, you can excute the following:
43-
44-
# make check
45-
46-
In order to use it, the 'golangci-lint' tool is needed, which can be found at:
47-
48-
* https://github.com/golangci/golangci-lint
41+
See [CONTRIBUTING.md](CONTRIBUTING.md).

0 commit comments

Comments
 (0)