File tree 2 files changed +18
-4
lines changed
2 files changed +18
-4
lines changed Original file line number Diff line number Diff line change @@ -19,7 +19,7 @@ init_command = [
19
19
' run' ,
20
20
' pip_init' ,
21
21
' --dry-run={{DRYRUN}}' ,
22
- ' --requirement=requirements-lintrunner.txt' ,
22
+ ' --requirement=install/ requirements-lintrunner.txt' ,
23
23
]
24
24
25
25
# Black + usort
@@ -46,7 +46,7 @@ init_command = [
46
46
' pip_init' ,
47
47
' --dry-run={{DRYRUN}}' ,
48
48
' --no-black-binary' ,
49
- ' --requirement=requirements-lintrunner.txt' ,
49
+ ' --requirement=install/ requirements-lintrunner.txt' ,
50
50
]
51
51
is_formatter = true
52
52
@@ -75,6 +75,6 @@ init_command = [
75
75
' run' ,
76
76
' pip_init' ,
77
77
' --dry-run={{DRYRUN}}' ,
78
- ' --requirement=requirements-lintrunner.txt' ,
78
+ ' --requirement=install/ requirements-lintrunner.txt' ,
79
79
]
80
80
is_formatter = true
Original file line number Diff line number Diff line change @@ -10,9 +10,23 @@ We actively welcome your pull requests.
10
10
2 . If you've added code that should be tested, add tests.
11
11
3 . If you've changed APIs, update the documentation.
12
12
4 . Ensure the test suite passes.
13
- 5 . Make sure your code lints .
13
+ 5 . Make sure your code is well-formatted using the repo linter. See "Linting" for details .
14
14
6 . If you haven't already, complete the Contributor License Agreement ("CLA").
15
15
16
+
17
+ ### Linting
18
+ Install the lintrunner dependencies from the requirements file.
19
+ ```
20
+ pip3 install -r install/requirements-lintrunner.txt
21
+ ```
22
+
23
+ After making your changes locally, run the lintrunner and apply all suggestions to your changes.
24
+ You can do this from the top-level torchchat directory - it will apply suggestions only to files that
25
+ you have touched.
26
+ ```
27
+ lintrunner -a
28
+ ```
29
+
16
30
## Contributor License Agreement ("CLA")
17
31
In order to accept your pull request, we need you to submit a CLA. You only need
18
32
to do this once to work on any of Meta's open source projects.
You can’t perform that action at this time.
0 commit comments