Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 2.32 KB

contributing.rst

File metadata and controls

36 lines (24 loc) · 2.32 KB

Contributing

Regardless of your experience level with Zeek, there are ways that you could help. If you submit a pull request with a proposed change, an extensive set of continuous integration tests will run via GitHub Actions. These help ensure the quality of the package.

Reporting bugs or improvement ideas

Issues are tracked on GitHub. There's an issue template that helps capture the necessary information.

Improving the documentation

The documentation is hosted on GitHub Pages

Documentation is auto-generated by Zeekygen comments in the scripts and reStructuredText files in docs/.

Contributing packet captures

Often, finding realistic traffic to test on is very difficult. There might be privacy concerns to sharing, or some data is just hard to come by in the wild. Having a development environment (which can be as simple as a VM or Docker container) where traffic can be generated will often address both these potential issues.

Please note that the more realistic the traffic is, the better the end result. Generating "cooked" traffic with Scapy or a hex editor can trigger a detection, but might not reliably replicate real-world conditions.

Increasing test coverage

This package comes with a test suite, using btest. Each Zeek script is analyzed for code coverage by the tests, and stats are reported via coveralls.