diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b076ad52..fbe1c06e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ Exercises are grouped into **concept** exercises which teach the [Python syllabu -🌟🌟  If you have not already done so, please take a moment to read [Code of Conduct][exercism-code-of-conduct]. πŸŒŸπŸŒŸ  +🌟🌟  If you have not already done so, please take a moment to read our [Code of Conduct][exercism-code-of-conduct]. πŸŒŸπŸŒŸ  It might also be helpful to look at [Being a Good Community Member][being-a-good-community-member] & [The words that we use][the-words-that-we-use]. Some defined roles in our community: [Contributors][exercism-contributors] **|** [Mentors][exercism-mentors] **|** [Maintainers][exercism-track-maintainers] **|** [Admins][exercism-admins] @@ -59,73 +59,30 @@ When in doubt, πŸ“› [ Open an issue ][open-an-issue]πŸ“› . We wil
-## :books: **Want to jump directly into Exercism specifications & detail?** - -✨ πŸ¦„  Here is the good stuff: - -[Structure][exercism-track-structure] **|** [Tasks][exercism-tasks] **|** [Concepts][exercism-concepts] **|** [Concept Exercises][concept-exercises] **|** [Practice Exercises][practice-exercises] **|** [Presentation][exercise-presentation] **|** [Writing Style Guide][exercism-writing-style] **|** [Markdown Specification][exercism-markdown-specification] - -Web-formatted  πŸ•ΈοΈ   versions are available in the [contributing section][website-contributing-section] of exercsim.org. - -
- -## 🌍   The Exercism Community   🌏 - -
- -🌟🌟  If you have not already done so, please take a moment to read our [Code of Conduct][exercism-code-of-conduct] & [Being a Good Community Member][being-a-good-community-member] documents. -It might also be helpful to take a look at [The words that we use][the-words-that-we-use]. - - -Some defined roles in our community: [Contributors][exercism-contributors] **|** [Mentors][exercism-mentors] **|** [Maintainers][exercism-track-maintainers] **|** [Admins][exercism-admins] - -
- ## In General
- Maintainers are happy to review your work and help you. πŸ’› πŸ’™  - - They may be in a different timezone βŒš , or tied up  πŸ§Ά  with other tasks. They will review your request as soon as they are able to. + - 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. - **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 on a single exercise, issue, or change. +- 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. - Pull Request titles and descriptions should make clear **what** has changed and **why**. - Please link  πŸ”—  to any related issues the PR addresses. -- πŸ“› [ Open an issue ][open-an-issue]πŸ“›  and discuss it _**before**_ creating a Pull Request making significant or breaking changes to an existing exercise. - - The same rule holds true for changes across multiple exercises. - - It is best to quickly discuss most changes with  πŸ§°  maintainers before doing a lot of work. +- πŸ“› [ Open an issue ][open-an-issue]πŸ“›  and discuss it with  πŸ§°  maintainers _**before**_: + - creating a Pull Request making significant or breaking changes. + - 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_). - Follow coding standards found in [PEP8][PEP8] (["For Humans" version here][pep8-for-humans]). - - We do have some more specific requirements. More on that [a little later](a-little-more-on-coding-standards). - 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. - Otherwise, watch out  βš οΈ  for trailing spaces, extra blank lines, extra spaces, and spaces in blank lines. -- The CI is going to run **a lot** of checks on your PR. Pay attention to the failures, try to understand and fix them. - - If you need help, comment in the PR or issue.  πŸ™‹πŸ½β€β™€οΈ   The maintainers are happy to help troubleshoot. - - -⚠️  Before committing βš οΈ +- Continuous Integration is going to run **a lot** of checks on your PR. Pay attention to the failures, try to understand and fix them. +- If you need help, comment in the PR or issue.  πŸ™‹πŸ½β€β™€οΈ   The maintainers are happy to help troubleshoot.
-  βš οΈ  Before committing βš οΈ  - -- [βœ”] Run [`configlet-lint`][configlet-lint] if the track [config.json](config-json) has been modified. -- [βœ”] Run [Prettier][prettier] on all markdown files. -- [βœ”] Run [flake8][flake8] & [pylint][pylint] to ensure all Python code files conform to general code style standards. -- [ ] (_Optionally_) run [yapf][yapf] to help format your code, and give you a head start on making the linters happy. -- [βœ”] Run `test/check-exercises.py [EXERCISE]` to check if your test changes function correctly. -- [βœ”] Run the `example.py` or `exemplar.py` file against the exercise test file to ensure that it passes without error. -- [βœ”] If you modified or created a `hints.md` file for a practice exercise, [regenerate](#generating-exercise-readmes) it. - - -
- -
- - -⚠️  Before committing βš οΈ - -
- Pre-Commit Checklist + ⚠️  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. @@ -138,9 +95,6 @@ Some defined roles in our community: [Contributors][exercism-contributors] **|*
- -
- ## πŸ“„ A Little More on Prose Writing Style and Standards