1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
Contributing to ZMap
====================
ZMap accepts contributions in the form of issues and pull requests. In either
case, before posting please [search](https://github.com/zmap/zmap/issues) to see
if your change or bug report has been addressed previously.
[INSTALL](INSTALL.md#building-from-source) provides guidance on building ZMap
from source.
Developing
----------
- ZMap code follows the [Linux kernel style guide][kernelguide]. We maintain [a
configuration file](/.clang-format) for `clang-format` that applies this
style. You can use the [format.sh](/format.sh) script to apply this style.
- Before submitting a PR, please rebase/squash your commits down to a single
commit. Follow these [commit message guidelines][guidelines], especially with
regard to formatting.
Reviewing
---------
- All commits must be reviewed in the form of a pull request by a ZMap
maintainer. This usually means @zakird or @dadrian (or both).
- All pull-requests should be squash-merged into master.
- When squash-merging, put the PR number in the commit title. GitHub does this
automatically in the web interface. Condense the commit messages down to a
single message; often this can just be the commit message from the first
commit in a PR. Follow the commit formatting guidelines [here][guidelines].
[kernelguide]: https://www.kernel.org/doc/Documentation/process/coding-style.rst
[guidelines]: https://github.com/torvalds/subsurface-for-dirk/blob/master/README#L92
|
