diff --git a/.github/issue-comment.md b/.github/issue-comment.md index 7482896f..ef7fe1d7 100644 --- a/.github/issue-comment.md +++ b/.github/issue-comment.md @@ -5,31 +5,51 @@ Hi! ๐Ÿ‘‹๐Ÿฝ ๐Ÿ‘‹ Welcome to the Exercism Python Repo! Thank you for opening an issue! ๐Ÿ  ๐ŸŒˆ โœจ
+-   If you are **requesting support**, we will be along shortly to help. (*generally within* **72 hours,** *often more quickly*). +-   **Found a problem** with tests, exercises or something else??  ๐ŸŽ‰ +  ◦ We'll take a look as soon as we can & identify what work is needed to fix it. *(generally within* **72 hours**). --   If you are **requesting support**, we will be along shortly to help. (*generally within* **72 hours,** *often more quickly*). --   **Found a problem** with tests, exercises or something else??  ๐ŸŽ‰ -  We'll take a look as soon as we can & identify what work is needed to fix it. *(generally within* **72 hours**). - -โ€‹           - If you'd also like to make a PR to **fix** the issue after discussing it, -             _We  ๐Ÿ’™  PRs that follow our [Exercism](https://exercism.org/docs/building) & [Track](https://github.com/exercism/python/blob/main/CONTRIBUTING.md) contributing guidelines!_ +โ€‹          ◦ _If you'd also like to make a PR to **fix** the issue, please have a quick look at the [Pull Requests][prs] doc._ +             _We  ๐Ÿ’™  PRs that follow our [Exercsim][exercism-guidelines] & [Track][track-guidelines] contributing guidelines!_ -   Here because of an obvious (*and* **small** *set of*) spelling, grammar, or punctuation issues with **one** exercise,   concept, or Python document?? ๐ŸŒŸ `Please feel free to submit a PR, linking to this issue.` ๐ŸŽ‰ -โ€‹        โ— Please **do not** run checks on the whole repo & submit a bunch of PRs. -             This creates longer review cycles & exhausts reviewers energy & time. -             It may also conflict with ongoing changes from other contributors. -             For anything complicated or ambiguous, **let's discuss things** -- we will likely welcome a PR from you. + + +- For anything complicated or ambiguous, **let's discuss things** -- we will likely welcome a PR from you. +- _Here to suggest a feature or new exercise??_ **Hooray!** Please keep in mind [_Chesterton's Fence_][chestertons-fence]. +_Thoughtful suggestions will likely result faster & more enthusiastic responses from maintainers._
-๐Ÿ’™  _While you are here..._ If you decide to help out with other [open issues](https://github.com/exercism/python/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22), you have our **gratitude** ๐Ÿ™Œ ๐Ÿ™Œ๐Ÿฝ. +๐Ÿ’›  ๐Ÿ’™  _While you are here..._ If you decide to help out with other [open issues][open-issues], you have our **gratitude** ๐Ÿ™Œ ๐Ÿ™Œ๐Ÿฝ. Anything tagged with `[help wanted]` and without `[Claimed]` is up for grabs. Comment on the issue and we will reserve it for you. ๐ŸŒˆ โœจ -_Here to suggest a feature or new exercise??_ **Hooray!** ๐ŸŽ‰   Please keep in mind [_Chesterton's Fence_](https://github.com/exercism/docs/blob/main/community/good-member/chestertons-fence.md). -_Thoughtful suggestions will likely result faster & more enthusiastic responses from maintainers._ + +[prs]: https://github.com/exercism/docs/blob/main/community/good-member/pull-requests.md +[EOL]: https://en.wikipedia.org/wiki/Newline +[chestertons-fence]: https://github.com/exercism/docs/blob/main/community/good-member/chestertons-fence.md +[exercism-guidelines]: https://exercism.org/docs/building +[open-issues]: https://github.com/exercism/python/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 +[track-guidelines]: https://github.com/exercism/python/blob/main/CONTRIBUTING.md diff --git a/.github/pr-commenter.yml b/.github/pr-commenter.yml index 6c9a5a07..b6c6af2c 100644 --- a/.github/pr-commenter.yml +++ b/.github/pr-commenter.yml @@ -200,7 +200,7 @@ comment:
โš ๏ธ  Please be aware โš ๏ธ -      _This repo does not generally accept Pull Requests unless they follow our [contributing guidelines](https://github.com/exercism/python/blob/main/CONTRIBUTING.md) and are:_ +      _This repo does not generally accept []Pull Requests](https://github.com/exercism/docs/blob/main/community/good-member/pull-requests.md) unless they follow our [contributing guidelines](https://github.com/exercism/python/blob/main/CONTRIBUTING.md) and are:_      1๏ธโƒฃ     Small, contained fixes for typos/grammar/punctuation/code syntax on [one] exercise,      2๏ธโƒฃ     Medium changes that have been agreed/discussed via a filed issue, diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1d47d563..816a44f6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -23,7 +23,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 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]. +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], and [Pull Requests][prs]. Some defined roles in our community: [Contributors][exercism-contributors] **|** [Mentors][exercism-mentors] **|** [Maintainers][exercism-track-maintainers] **|** [Admins][exercism-admins] @@ -46,6 +46,8 @@ Please ๐Ÿ“› [ Open an issue ][open-an-issue]๐Ÿ“› , and let us kno
## ๐Ÿšง **Did you write a patch that fixes a bug?** +_Before you get started, please review [Pull Requests][prs]._ + ๐Ÿ’› ๐Ÿ’™  **We Warmly Welcome Pull Requests that are:** @@ -62,6 +64,7 @@ When in doubt, ๐Ÿ“› [ Open an issue ][open-an-issue]๐Ÿ“› . We wil

In General


+- Please make sure to have a quick read-through of our Exercism [Pull Requests][prs] document before jumping in. ๐Ÿ˜… - Maintainers are happy to review your work and help troubleshoot with you. ๐Ÿ’› ๐Ÿ’™  - Requests are reviewed as soon as is practical/possible. - (โ— ) Reviewers may be in a different timezone โŒš , or tied up  ๐Ÿงถ  with other tasks. @@ -326,7 +329,7 @@ If a practice exercise has an auto-generated `_test.py` file, the _Exercise Structure with Auto-Generated Test Files_ -```Bash +```Graphql [/ โ”œโ”€โ”€ .docs โ”‚ โ””โ”€โ”€ instructions.md @@ -394,6 +397,7 @@ configlet generate --spec-path path/to/problem/specifications
+ [.flake8]: https://github.com/exercism/python/blob/main/.flake8 [.style.yapf]: https://github.com/exercism/python/blob/main/.style.yapf [EOL]: https://en.wikipedia.org/wiki/Newline @@ -438,6 +442,7 @@ configlet generate --spec-path path/to/problem/specifications [practice-exercises]: https://github.com/exercism/docs/blob/main/building/tracks/practice-exercises.md [prettier]: https://prettier.io/ [problem-specifications]: https://github.com/exercism/problem-specifications +[prs]: https://github.com/exercism/docs/blob/main/community/good-member/pull-requests.md [pylint-disable-check]: https://pylint.pycqa.org/en/latest/user_guide/message-control.html#block-disables [pylint]: https://pylint.pycqa.org/en/v2.11.1/user_guide/index.html [pylintrc]: https://github.com/exercism/python/blob/main/pylintrc diff --git a/README.md b/README.md index dc3c6c0e..7b50ab4f 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ Exercises are grouped into **concept** exercises which teach the [Python syllabu ๐ŸŒŸ๐ŸŒŸ  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]. +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], and [Pull Requests][prs]. Some defined roles in our community: [Contributors][exercism-contributors] **|** [Mentors][exercism-mentors] **|** [Maintainers][exercism-track-maintainers] **|** [Admins][exercism-admins] @@ -35,7 +35,7 @@ Some defined roles in our community: [Contributors][exercism-contributors] **|* We ๐Ÿ’› ๐Ÿ’™   Pull Requests. **But our maintainers generally can't accept _unsolicited_ PRs.** Check our [help wanted][open-issues] list or [open an issue ][open-an-issue] for discussion first. -We  โœจ๐Ÿ’™  ๐Ÿ’›  ๐Ÿ’™ โœจ  PRs that follow our **[Contributing Guidelines][contributing-guidelines]**. +We  โœจ๐Ÿ’™  ๐Ÿ’›  ๐Ÿ’™ โœจ  [PRs][prs] that follow our **[Contributing Guidelines][contributing-guidelines]**.
@@ -72,7 +72,7 @@ Starting with `Python 3.8.6`, examples, recipes, and other code in the Python do Some software incorporated into Python is under different licenses. The licenses are listed with code falling under that license. See [Licenses and Acknowledgements for Incorporated Software](https://docs.python.org/3/license.html#otherlicenses) for an incomplete list of these licenses. -## License +## Exercism Python Track License This repository uses the [MIT License](/LICENSE). @@ -96,6 +96,7 @@ This repository uses the [MIT License](/LICENSE). [exercism-writing-style]: https://github.com/exercism/docs/blob/main/building/markdown/style-guide.md [open-an-issue]: https://github.com/exercism/python/issues/new/choose [open-issues]: https://github.com/exercism/python/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22 +[prs]: https://github.com/exercism/docs/blob/main/community/good-member/pull-requests.md [practice-exercises]: https://github.com/exercism/docs/blob/main/building/tracks/practice-exercises.md [psf-license]: https://docs.python.org/3/license.html#psf-license [python-syllabus]: https://exercism.org/tracks/python/concepts