CONTRIBUTING.md

   1 # Contributing to Zstandard
   2 We want to make contributing to this project as easy and transparent as
   3 possible.
   4
   5 ## Our Development Process
   6 New versions are being developed in the "dev" branch,
   7 or in their own feature branch.
   8 When they are deemed ready for a release, they are merged into "master".
   9
  10 As a consequences, all contributions must stage first through "dev"
  11 or their own feature branch.
  12
  13 ## Pull Requests
  14 We actively welcome your pull requests.
  15
  16 1. Fork the repo and create your branch from `dev`.
  17 2. If you've added code that should be tested, add tests.
  18 3. If you've changed APIs, update the documentation.
  19 4. Ensure the test suite passes.
  20 5. Make sure your code lints.
  21 6. If you haven't already, complete the Contributor License Agreement ("CLA").
  22
  23 ## Contributor License Agreement ("CLA")
  24 In order to accept your pull request, we need you to submit a CLA. You only need
  25 to do this once to work on any of Facebook's open source projects.
  26
  27 Complete your CLA here: <https://code.facebook.com/cla>
  28
  29 ## Issues
  30 We use GitHub issues to track public bugs. Please ensure your description is
  31 clear and has sufficient instructions to be able to reproduce the issue.
  32
  33 Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
  34 disclosure of security bugs. In those cases, please go through the process
  35 outlined on that page and do not file a public issue.
  36
  37 ## Coding Style
  38 * 4 spaces for indentation rather than tabs
  39
  40 ## License
  41 By contributing to Zstandard, you agree that your contributions will be licensed
  42 under both the [LICENSE](LICENSE) file and the [COPYING](COPYING) file in the root directory of this source tree.