More formatting and spelling and images.
This commit is contained in:
@@ -76,9 +76,9 @@ When in doubt, 📛 [ Open an issue ][open-an-issue]📛 . We wil
|
|||||||
- for changes across multiple exercises, even if they are typos or small.
|
- for changes across multiple exercises, even if they are typos or small.
|
||||||
- anything that is going to require doing a lot of work (_on your part or the maintainers part_).
|
- anything that is going to require doing a lot of work (_on your part or the maintainers part_).
|
||||||
- Follow coding standards found in [PEP8][PEP8] (["For Humans" version here][pep8-for-humans]).
|
- Follow coding standards found in [PEP8][PEP8] (["For Humans" version here][pep8-for-humans]).
|
||||||
- All files should have a proper [EOL][EOL] at the end. This means one carriage return at the end of the final line of text in files.
|
- All files should have a proper [EOL][EOL] at the end. This means one carriage return at the end of the final line.
|
||||||
- Otherwise, watch out ⚠️ for trailing spaces, extra blank lines, extra spaces, and spaces in blank lines.
|
- Otherwise, watch out ⚠️ for trailing spaces, extra blank lines, extra spaces, and spaces in blank lines.
|
||||||
- Continuous Integration is going to run **a lot** of checks on your PR. Pay attention to the failures, try to understand and fix them.
|
- Continuous Integration is going to run **a lot** of checks. Pay attention to failures & try to understand and fix them.
|
||||||
- If you need help, comment in the PR or issue. 🙋🏽♀️ The maintainers are happy to help troubleshoot.
|
- If you need help, comment in the PR or issue. 🙋🏽♀️ The maintainers are happy to help troubleshoot.
|
||||||
|
|
||||||
|
|
||||||
@@ -92,6 +92,7 @@ When in doubt, 📛 [ Open an issue ][open-an-issue]📛 . We wil
|
|||||||
4. Run `test/check-exercises.py [EXERCISE]` to check if your test changes function correctly.
|
4. Run `test/check-exercises.py [EXERCISE]` to check if your test changes function correctly.
|
||||||
5. Run the `example.py` or `exemplar.py` file against the exercise test file to ensure that it passes without error.
|
5. Run the `example.py` or `exemplar.py` file against the exercise test file to ensure that it passes without error.
|
||||||
6. If you modified or created a `hints.md` file for a practice exercise, [regenerate](#generating-exercise-readmes) it.
|
6. If you modified or created a `hints.md` file for a practice exercise, [regenerate](#generating-exercise-readmes) it.
|
||||||
|
|
||||||
</details>
|
</details>
|
||||||
<br>
|
<br>
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user