|
1 | | -How to Submit Patches to the libseccomp Project |
| 1 | +How to Submit Patches to the libseccomp-golang Project |
2 | 2 | =============================================================================== |
3 | 3 | https://github.com/seccomp/libseccomp-golang |
4 | 4 |
|
5 | 5 | 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 |
9 | 9 | project. |
10 | 10 |
|
11 | 11 | ## Test Your Code Using Existing Tests |
12 | 12 |
|
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: |
25 | 15 |
|
26 | 16 | # make check |
27 | 17 |
|
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 |
29 | 21 |
|
30 | 22 | ## Add New Tests for New Functionality |
31 | 23 |
|
|
0 commit comments