CONTRIBUTING.md

Contribution guidelines

First off, thank you for considering contributing to h3oh3o.

If your contribution is not straightforward, please first discuss the change you wish to make by creating a new issue before making the change.

Reporting issues

Before reporting an issue on the issue tracker, please check that it has not already been reported by searching for some related keywords.

Pull requests

Try to do one pull request per change.

Updating the changelog

Update the changes you have made in CHANGELOG file under the Unreleased section.

Add the changes of your pull request to one of the following subsections, depending on the types of changes defined by Keep a changelog:

• Added for new features.
• Changed for changes in existing functionality.
• Deprecated for soon-to-be removed features.
• Removed for now removed features.
• Fixed for any bug fixes.
• Security in case of vulnerabilities.

If the required subsection does not exist yet under Unreleased, create it!

Developing

Useful Commands

• Run Clippy:

  cargo clippy --all-targets --all-features

• Run tests:

  cd h3oh3o/h3tests
  mkdir -p build && cd build
  cmake .. -DCMAKE_BUILD_TYPE=Debug
  make
  make test

• Run benchmarks:

  mkdir -p build && cd build
  cmake .. -DCMAKE_BUILD_TYPE=Release
  make benchmarks

• Check to see if there are code formatting issues

  cargo +nightly fmt --all -- --check

• Format the code in the project

  cargo +nightly fmt --all