Get Involved

Anyone is welcome to contribute to Hyperscan.

Filing Bugs

If you have found a bug in Hyperscan, please file a bug at our Github issues page. Please include the Hyperscan version, a reproducible test case and describe the environment in which Hyperscan is running (platform, operating system, build environment).

Contributing Code

Hyperscan collaboration is done primarily via email on the mailing list. To contribute code to Hyperscan, please register for the list, generate a patch or series of patches and post them to the list for review. Here are some guidelines:

Patches should apply to the code in the Hyperscan github repo’s master branch.

  • Patches should be generated with git commit. You can use git format-patch and git send-email to prepare and send them easily.
  • Ensure that you own the code in your patch and that there are no licensing issues with its contribution to Hyperscan.
  • The commits must have a Signed-off-by line (using git’s --signoff option). It certifies that you wrote them and have the right to contribute them.
  • Respect the formatting and coding conventions used in existing code.
  • Prepend “[PATCH]” to the subject line of your email to distinguish your patch from other discussion on the mailing list.

License and Copyright

The Hyperscan source code is licensed under a 3-clause BSD license. As a contributor to Hyperscan, you agree that any contributions to the project will be licensed under these terms.

The Hyperscan project does not require copyright assignment. All code in the library is owned by its respective contributors.

Code of Conduct

As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.

Examples of unacceptable behavior by participants include:

  • The use of sexualized language or imagery
  • Personal attacks
  • Trolling or insulting/derogatory comments
  • Public or private harassment
  • Publishing other’s private information, such as physical or electronic addresses, without explicit permission
  • Other unethical or unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.

This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the Contributor Covenant, version 1.2.0, available from

In addition, please note the Terms of Service.