Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (28 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

37 lines (28 loc) · 1.79 KB

Contributing to OpenZL

We want to make contributing to this project as easy and transparent as possible.

Pull Requests

We actively welcome your pull requests.

  1. Fork the repo and create your branch from dev.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. If you haven't already, complete the Contributor License Agreement ("CLA").

Common reasons for a rejected pull request

  • OpenZL currently expects its library of standard codecs to be generalized and well-tested. We are happy to link to useful custom codecs, but cannot accept pull requests adding them to the library. If you have a general codec that you would like to contribute, please create an issue for discussion before submitting a pull request.
  • Large codemods are difficult to verify and will be rejected unless they are accompanied with the generating scripts.
  • Low-impact pull requests that are transparently for "stat-padding" will be rejected.

Contributor License Agreement ("CLA")

In order to accept your pull request, we need you to submit a CLA. You only need to do this once to work on any of Facebook's open source projects.

Complete your CLA here: https://code.facebook.com/cla

Issues

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.

Facebook has a bounty program for the safe disclosure of security bugs. In those cases, please go through the process outlined on that page and do not file a public issue.

License

By contributing to zstrong, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.