From 987666f414e01ec040cb31e3c61b2ff2b6d3b5ac Mon Sep 17 00:00:00 2001 From: BethanyG Date: Thu, 14 Oct 2021 17:00:08 -0700 Subject: [PATCH] More formatting and spelling and images. --- CONTRIBUTING.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8d9293a4..8728bb52 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,8 +64,8 @@ When in doubt, ๐Ÿ“› [ Open an issue ][open-an-issue]๐Ÿ“› . We wil
- Maintainers are happy to review your work and help you. ๐Ÿ’› ๐Ÿ’™  - - They may be in a different timezone โŒš , or tied up  ๐Ÿงถ  with other tasks. - Maintainers will review your request as soon as they are able to. + - **BUT** They may be in a different timezone โŒš , or tied up  ๐Ÿงถ  with other tasks. - **Please wait at least 72 hours before pinging.** - If you'd like in-progress feedback or discussion, please mark your Pull Request as a **`[draft]`** - Pull requests should be focused around a single exercise, issue, or change. @@ -85,14 +85,15 @@ When in doubt, ๐Ÿ“› [ Open an issue ][open-an-issue]๐Ÿ“› . We wil
โš ๏ธ  Pre-Commit Checklist โš ๏ธ +
-1. Run [`configlet-lint`][configlet-lint] if the track [config.json](config-json) has been modified. -2. Run [Prettier][prettier] on all markdown files. - - (_Optionally_) run [yapf][yapf] to help format your code, and give you a head start on making the linters happy. -3. Run [flake8][flake8] & [pylint][pylint] to ensure all Python code files conform to general code style standards. -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. -6. If you modified or created a `hints.md` file for a practice exercise, [regenerate](#generating-exercise-readmes) it. + 1.  Run [`configlet-lint`][configlet-lint] if the track [config.json](config-json) has been modified. + 2.  Run [Prettier][prettier] on all markdown files. + - (_Optionally_) run [yapf][yapf] to help format your code, and give you a head start on making the linters happy. + 3.  Run [flake8][flake8] & [pylint][pylint] to ensure all Python code files conform to general code style standards. + 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. + 6.  If you modified or created a `hints.md` file for a practice exercise, [regenerate](#generating-practice-exercise-documents) it.

@@ -104,7 +105,7 @@ When in doubt, ๐Ÿ“› [ Open an issue ][open-an-issue]๐Ÿ“› . We wil Non-code content (_exercise introductions & instructions, hints, concept write-ups, documentation etc._) should be written in [American English][american-english]. We strive to watch [the words we use][the-words-that-we-use]. -When a word or phrase usage is contested | ambiguous, we default to what is best understood by our international community of learners, even if it "sounds a little weird" to a "native" American English speaker. +When a word or phrase usage is contested/ambiguous, we default to what is best understood by our international community of learners, even if it "sounds a little weird" to a "native" American English speaker. Our documents use [Markdown][markdown-language], with certain [alterations][exercism-markdown-widgets] & [additions][exercism-internal-linking]. Here is our full [Markdown Specification][exercism-markdown-specification].  ๐Ÿ“ We format/lint our Markdown with [Prettier][prettier]. โœจ @@ -210,8 +211,6 @@ Some of our code is old and does not (yet) conform to all these standards. We k This track officially supports Python = `3.8` The track `test runner`, `analyzer`, and `representer` run in docker on `python:3.9-slim`. -Although the majority of test cases are written using `unittest.TestCase`, - * All exercises should be written for compatibility with Python = `3.8` or `3.9`. * Version backward _incompatibility_ (*e.g* an exercise using a `3.8` or `3.9` **only** feature) should be clearly noted in any exercise hits, links, introductions or other notes.