Summary: https://github.com/facebookincubator/mvfst/issues/219 Reviewed By: kvtsoy Differential Revision: D31022876 fbshipit-source-id: 6dc4e76136d5a2e43f3daf8dd708b2cf3e688e54
1.6 KiB
Contributing to MVFST
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
We use clang-format tool for coding style.
Please run clang-format -i <filename>
on file, where changes has been made
before you commit them.
License
By contributing to MVFST, you agree that your contributions will be licensed under its BSD license.