@@ -173,13 +173,14 @@ Information on QA tools:
173
173
for more important matters".
174
174
- `isort `_ - isort is a Python utility / library to sort imports alphabetically, and
175
175
automatically separated into sections and by type.
176
- - `flake8 `_ - A Python linter for enforcing a style guide with PEP (Python Enhancement
177
- Proposals).
176
+ - `flake8 `_ - A Python linter that checks Python code for style and syntax errors, and
177
+ for enforcing a style guide with ` PEP (Python Enhancement Proposals)`_ .
178
178
179
179
.. _pre-commit : https://pre-commit.com/
180
180
.. _black : https://black.readthedocs.io/en/stable/
181
181
.. _isort : https://pycqa.github.io/isort/
182
182
.. _flake8 : https://flake8.pycqa.org/en/latest/
183
+ .. _PEP (Python Enhancement Proposals) : https://peps.python.org/pep-0000/
183
184
184
185
Helpful Knowledge
185
186
-----------------
@@ -196,9 +197,11 @@ Jobs include:
196
197
2. Build conda CI/CD environment with different Python versions, build and install
197
198
the package, and run unit test suite with ``pytest ``
198
199
200
+ Here's an example of GitHub Actions in "action": https://github.com/tomvothecoder/python-template-repo/actions
201
+
199
202
*To save time and resources on build cycles, GitHub Actions has been configured to
200
203
automatically skip jobs instead of re-executing based on the files that are committed. For
201
- example, if docs are committed, then the unit tests will not run. *
204
+ example, if docs are committed then the unit tests will not run. *
202
205
203
206
Additional Configuration
204
207
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
0 commit comments