Skip to content

Commit 83efe37

Browse files
committed
CONTRIBUTING: break down steps and add an autogen.sh step. [skip ci]
Split the configure and build and test step up; they all should be done after the user makes their changes, so add that as a step. (The autogen and configure steps will probably only need to be done once, but the build and test steps may have to be done repeatedly until everything builds and works.)
1 parent 40ac38a commit 83efe37

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -61,12 +61,24 @@ and ask!
6161
supports these options,
6262
* have the `Makefile` support `make depend` and the `configure` script run it.
6363

64-
6) Configure and build
64+
6) Make your changes
65+
66+
7) Generate the configure scripts
67+
```
68+
./autogen.sh
69+
```
70+
71+
8) Configure
72+
```
73+
./configure
74+
```
75+
76+
9) Build
6577
```
66-
./configure && make -s && make check
78+
make -s
6779
```
6880

69-
7) Add/update tests
81+
10) Add/update tests
7082
The `tests` directory contains regression tests of the dissection of captured
7183
packets. Those captured packets were saved running tcpdump with option
7284
`-w sample.pcap`. Additional options, such as `-n`, are used to create relevant
@@ -96,22 +108,22 @@ and ask!
96108
It is often useful to have test outputs with different verbosity levels
97109
(none, `-v`, `-vv`, `-vvv`, etc.) depending on the code.
98110

99-
8) Test using `make check` (current build options) and `./build_matrix.sh`
111+
11) Test using `make check` (current build options) and `./build_matrix.sh`
100112
(a multitude of build options, build systems and compilers). If you can,
101113
test on more than one operating system. Don't send a pull request until
102114
all tests pass.
103115

104-
9) Try to rebase your commits to keep the history simple.
116+
12) Try to rebase your commits to keep the history simple.
105117
```
106118
git fetch upstream
107119
git rebase upstream/master
108120
```
109121
(If the rebase fails and you cannot resolve, issue `git rebase --abort`
110122
and ask for help in the pull request comment.)
111123

112-
10) Once 100% happy, put your work into your forked repository using `git push`.
124+
13) Once 100% happy, put your work into your forked repository using `git push`.
113125

114-
11) [Initiate and send](https://help.github.com/articles/using-pull-requests/)
126+
14) [Initiate and send](https://help.github.com/articles/using-pull-requests/)
115127
a pull request.
116128
This will trigger the upstream repository CI tests.
117129

0 commit comments

Comments
 (0)