File tree 1 file changed +18
-4
lines changed
1 file changed +18
-4
lines changed Original file line number Diff line number Diff line change @@ -157,12 +157,26 @@ To typecheck, run:
157
157
mypy -p git
158
158
```
159
159
160
- Configuration for flake8 is in the ` ./.flake8 ` file.
160
+ #### CI (and tox)
161
161
162
- Configurations for ` mypy ` , ` pytest ` , ` coverage.py ` , and ` black ` are in ` ./pyproject.toml ` .
162
+ The same linting, and running tests on all the different supported Python versions, will be performed:
163
163
164
- The same linting and testing will also be performed against different supported python versions
165
- upon submitting a pull request (or on each push if you have a fork with a "main" branch and actions enabled).
164
+ - Upon submitting a pull request.
165
+ - On each push, * if* you have a fork with a "main" branch and GitHub Actions enabled.
166
+ - Locally, if you run [ ` tox ` ] ( https://tox.wiki/ ) (this skips any Python versions you don't have installed).
167
+
168
+ #### Configuration files
169
+
170
+ Specific tools:
171
+
172
+ - Configurations for ` mypy ` , ` pytest ` , ` coverage.py ` , and ` black ` are in ` ./pyproject.toml ` .
173
+ - Configuration for ` flake8 ` is in the ` ./.flake8 ` file.
174
+
175
+ Orchestration tools:
176
+
177
+ - Configuration for ` pre-commit ` is in the ` ./.pre-commit-config.yaml ` file.
178
+ - Configuration for ` tox ` is in ` ./tox.ini ` .
179
+ - Configuration for GitHub Actions (CI) is in files inside ` ./.github/workflows/ ` .
166
180
167
181
### Contributions
168
182
You can’t perform that action at this time.
0 commit comments