Skip to content

Commit c7497fa

Browse files
Update README with links to PEP and GH Actions example (#2)
1 parent df7d17a commit c7497fa

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -173,13 +173,14 @@ Information on QA tools:
173173
for more important matters".
174174
- `isort`_ - isort is a Python utility / library to sort imports alphabetically, and
175175
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)`_.
178178

179179
.. _pre-commit: https://pre-commit.com/
180180
.. _black: https://black.readthedocs.io/en/stable/
181181
.. _isort: https://pycqa.github.io/isort/
182182
.. _flake8: https://flake8.pycqa.org/en/latest/
183+
.. _PEP (Python Enhancement Proposals): https://peps.python.org/pep-0000/
183184

184185
Helpful Knowledge
185186
-----------------
@@ -196,9 +197,11 @@ Jobs include:
196197
2. Build conda CI/CD environment with different Python versions, build and install
197198
the package, and run unit test suite with ``pytest``
198199

200+
Here's an example of GitHub Actions in "action": https://github.com/tomvothecoder/python-template-repo/actions
201+
199202
*To save time and resources on build cycles, GitHub Actions has been configured to
200203
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.*
202205

203206
Additional Configuration
204207
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)