xref: /aosp_15_r20/external/ktfmt/CONTRIBUTING.md (revision 5be3f65c8cf0e6db0a7e312df5006e8e93cdf9ec)
1# Contributing to ktfmt
2We want to make contributing to this project as easy and transparent as
3possible.
4
5**If you plan a significant change, please first start a discussion as a GitHub Issue.**
6
7## Pull Requests
8We actively welcome your pull requests.
9
101. Fork the repo and create your branch from `main`.
112. If you've added code that should be tested, add tests.
123. If you've changed APIs, update the documentation.
134. Ensure the test suite passes.
145. Make sure your code lints.
156. If you haven't already, complete the Contributor License Agreement ("CLA").
167. If applicable add relevant change information to the changelog
17
18Note that pull requests are imported into Facebook's internal repository and code is
19formatted as part of that process (using ktfmt!). It's not necessary for PRs to stick
20to the existing style of this repository, though that does make code reviews easier.
21
22## Contributor License Agreement ("CLA")
23In order to accept your pull request, we need you to submit a CLA. You only need
24to do this once to work on any of Facebook's open source projects.
25
26Complete your CLA here: <https://code.facebook.com/cla>
27
28## Issues
29We use GitHub issues to track public bugs. Please ensure your description is
30clear and has sufficient instructions to be able to reproduce the issue.
31
32Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
33disclosure of security bugs. In those cases, please go through the process
34outlined on that page and do not file a public issue.
35
36## License
37By contributing to ktfmt, you agree that your contributions will be licensed
38under the LICENSE file in the root directory of this source tree.
39