You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Move linters from CircleCI to GitHub actions (#289)
* Move linters from CircleCI to GitHub actions
* Update README with fresh black links and a GitHub actions badge
* Only trigger push workflow on master
* Remove CircleCI integration
The best way to get support for Real Python courses & articles and code in this repository is to join one of our [weekly Office Hours calls](https://realpython.com/office-hours/) or to ask your question in the [RP Community Slack](https://realpython.com/community/).
10
+
The best way to get support for Real Python courses, articles, and code in this repository is to join one of our [weekly Office Hours calls](https://realpython.com/office-hours/) or to ask your question in the [RP Community Slack](https://realpython.com/community/).
10
11
11
-
Due to time constraints we cannot provide 1:1 support via GitHub. See you on Slack or on the next Office Hours call 🙂
12
+
Due to time constraints, we cannot provide 1:1 support via GitHub. See you on Slack or on the next Office Hours call 🙂
12
13
13
14
## Adding Source Code & Sample Projects to This Repo (RP Contributors)
14
15
15
16
### Running Code Style Checks
16
17
17
-
We use [flake8](http://flake8.pycqa.org/en/latest/) and [black](https://github.com/ambv/black) to ensure a consistent code style for all of our sample code in this repository.
18
+
We use [flake8](http://flake8.pycqa.org/en/latest/) and [black](https://black.readthedocs.io/) to ensure a consistent code style for all of our sample code in this repository.
18
19
19
20
Run the following commands to validate your code against the linters:
20
21
@@ -25,11 +26,11 @@ $ black --check .
25
26
26
27
### Running Python Code Formatter
27
28
28
-
We're using a tool called [black](https://github.com/ambv/black) on this repo to ensure consistent formatting. On CI it runs in "check" mode to ensure any new files added to the repo are following PEP 8. If you see linter warnings that say something like "would reformat some_file.py" it means black disagrees with your formatting.
29
+
We're using a tool called [black](https://black.readthedocs.io/) on this repo to ensure consistent formatting. On CI it runs in "check" mode to ensure any new files added to the repo follow PEP 8. If you see linter warnings that say something like "would reformat some_file.py" it means that black disagrees with your formatting.
29
30
30
-
**The easiest way to resolve these errors is to just run Black locally on the code and then committing those changes, as explained below.**
31
+
**The easiest way to resolve these errors is to run Black locally on the code and then commit those changes, as explained below.**
31
32
32
-
To automatically re-format your code to be consistent with our code style guidelines, run [black](https://github.com/ambv/black) in the repository root folder:
33
+
To automatically re-format your code to be consistent with our code style guidelines, run [black](https://black.readthedocs.io/) in the repository root folder:
0 commit comments