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