We want to make contributing to this project as easy and as transparent as possible.
The code of conduct is described in CODE_OF_CONDUCT.md
This library is actively being used by several projects on Facebook. We don't expect any major changes in APIs exposed by libraries, however bug fixes, performance improvements and code maintenance is likely to happen on a regular basis. New APIs or functionalities might be added as per future needs.
We actively welcome your pull requests.
- Fork the repo and create your branch from
master. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- If you haven't already, complete the 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: CLA - Agreement
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.
Please try to follow the existing coding style within fbzmq code. For C++
code, our style is
- 2 spaces for indentation rather than tabs
- 80 character line length
- Use clang-format for formatting code
By contributing to fbzmq, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.