Skip to content

Commit cd7559e

Browse files
committed
Update CONTRIBUTING.md
1 parent 84cc317 commit cd7559e

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

CONTRIBUTING.md

+10-7
Original file line numberDiff line numberDiff line change
@@ -7,25 +7,28 @@ We actively welcome your pull requests.
77

88
1. Fork the repo and create your branch from `main`.
99
2. If you've added code that should be tested, add tests.
10-
3. If you've changed APIs, update the documentation.
11-
4. Ensure the test suite passes.
12-
5. Make sure your code lints.
10+
3. Ensure the test suite passes by running `pytest`
11+
4. Auto-reformat your code with [black]/[isort] by running `make format`
12+
5. Make sure your code lints. (`make lint` to run linters)
1313
6. If you haven't already, complete the Contributor License Agreement ("CLA").
1414

15+
[black]: https://black.readthedocs.io/
16+
[isort]: https://pycqa.github.io/isort/
17+
1518
## Contributor License Agreement ("CLA")
1619
In order to accept your pull request, we need you to submit a CLA. You only need
17-
to do this once to work on any of Facebook's open source projects.
20+
to do this once to work on any of Meta's open source projects.
1821

1922
Complete your CLA here: <https://code.facebook.com/cla>
2023

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

25-
Facebook has a [bounty program](https://www.facebook.com/whitehat/) for the safe
28+
Meta has a [bounty program](https://www.facebook.com/whitehat/) for the safe
2629
disclosure of security bugs. In those cases, please go through the process
2730
outlined on that page and do not file a public issue.
2831

2932
## License
30-
By contributing to torchdynamo, you agree that your contributions will be licensed
31-
under the LICENSE file in the root directory of this source tree.
33+
By contributing to TorchDynamo, you agree that your contributions will be licensed
34+
under the LICENSE file in the root directory of this source tree.

0 commit comments

Comments
 (0)