1.5 KiB
Contributing to ZMap
ZMap accepts contributions in the form of issues and pull requests. In either case, before posting please search to see if your change or bug report has been addressed previously.
INSTALL provides guidance on building ZMap from source.
Developing
-
ZMap code follows the Linux kernel style guide. We maintain a configuration file for
clang-formatthat applies this style. You can use the 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, 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.