Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (53 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

73 lines (53 loc) · 2.29 KB
Raw

Contributing to Boost.int256

We are welcoming contributions

  • Bug fixes and test cases for them
  • New algorithms (with tests, documentation, complexity notes, and a reference)
  • Documentation, examples, performance work
  • Concept refinements (handle with care as these are API-visible)

Getting set up

Clone the Boost superproject:

git clone --depth 1 https://github.com/boostorg/boost
cd boost
git submodule update --init --depth 1
./bootstrap.sh
./b2 headers

Then replace libs/int256/ with your fork:

rm -rf libs/int256
git clone https://github.com/<you>/int256 libs/int256
cd libs/int256
git remote add upstream https://github.com/boostorg/int256

Building and testing

  • Headers only: ./b2 headers from boost root
  • All tests: ./b2 from libs/int256/test
  • Single test: ./b2 github_issue_207 from libs/int256/test
  • Different C++ standard: ./b2 cxxstd=20
  • Different compiler: ./b2 toolset=clang

Pull request process

  • Fork, branch from develop, PR back to develop
  • One logical change per PR; rebase before requesting review
  • Tests required for new features and bug fixes
  • Open (non-draft) PRs are assumed ready for review. Use GitHub's Draft state while iterating, then mark the PR as Ready for review when you want maintainers to look at it.
  • A maintainer will review within ~2 weeks (see Maintainers below)
  • Squash on merge by default

Merge criteria

Before a PR is merged, all of the following must hold:

  1. CI is green on the full matrix.
  2. New behavior has tests.
  3. Bug fixes have a regression test.
  4. Documentation under doc/ is updated if the public API changed.
  5. No new compiler warnings on the supported toolchains.
  6. The PR is rebased on current develop with a clean commit history.
  7. The principal maintainer has approved.

Reporting bugs

  1. Search existing issues first
  2. Note compiler, version, OS, Boost version
  3. Minimal reproducer on Compiler Explorer
  4. Expected Output versus Actual Output is explained.

Security

See SECURITY.md.

License

By contributing, you agree your contribution is licensed under the Boost Software License 1.0.