Summary: https://github.com/facebook/proxygen/issues/371 Reviewed By: kvtsoy Differential Revision: D31022945 fbshipit-source-id: fc9d35c0a6d89e6da820d073810f401099999474
1.8 KiB
Contributing to Proxygen
Here's a quick rundown of how to contribute to this project.
Code of Conduct
The code of conduct is described in CODE_OF_CONDUCT.md
Our Development Process
We develop on a private branch internally at Facebook. We regularly update this github project with the changes from the internal repo. External pull requests are cherry-picked into our repo and then pushed back out.
Pull Requests
We actively welcome your pull requests.
- Fork the repo and create your branch from
main
. - 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").
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.
Coding Style
- 2 spaces for indentation rather than tabs
- 80 character line length
- Use
Type* foo
notType *foo
. - Align parameters passed to functions.
- Prefer
std::make_unique<Foo>
tonew Foo
. In general, we discourage use of rawnew
ordelete
.
License
By contributing to Proxygen, you agree that your contributions will be licensed under its BSD license.