Added links to Pull Requests documents for Contributing, readme, issue responder and pr responder.
This commit is contained in:
BethanyG
52
.github/issue-comment.md
vendored
52
.github/issue-comment.md
vendored
@@ -5,31 +5,51 @@ Hi! 👋🏽 👋 Welcome to the Exercism Python Repo!
|
||||
Thank you for opening an issue! 🐍 🌈 ✨
|
||||
|
||||
<br>
|
||||
- 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.
|
||||
<ul>
|
||||
<table>
|
||||
<td>
|
||||
<details>
|
||||
<summary>‼️ <b><em>Please Do Not</em></b> ‼️</summary>
|
||||
<br>
|
||||
|
||||
❗ Please keep in mind that inserting only blank lines, making a closing bracket drop to the next line, changing a
|
||||
word to a synonym without obvious reason, adding trailing space that's not a[ EOL](https://en.wikipedia.org/wiki/Newline) for the very end of text files,
|
||||
and other "changes just to change things" are **not** considered helpful, and will likely be closed by reviewers.
|
||||
❗ 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.
|
||||
❗ Insert only blank lines, make a closing bracket drop to the next line, change a word
|
||||
to a synonym without obvious reason, or add trailing space that's not an[ EOL][EOL] for the very end of text files.
|
||||
❗ Introduce arbitrary changes "just to change things" .
|
||||
|
||||
_...These sorts of things are **not** considered helpful, and will likely be closed by reviewers._
|
||||
|
||||
</details>
|
||||
</td>
|
||||
</table>
|
||||
</ul>
|
||||
|
||||
- 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._
|
||||
|
||||
<br>
|
||||
|
||||
💙 _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
|
||||
|
||||
2
.github/pr-commenter.yml
vendored
2
.github/pr-commenter.yml
vendored
@@ -200,7 +200,7 @@ comment:
|
||||
<details open>
|
||||
<summary>⚠️ <b>Please be aware</b> ⚠️ </summary>
|
||||
|
||||
_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,
|
||||
|
||||
@@ -23,7 +23,7 @@ Exercises are grouped into **concept** exercises which teach the [Python syllabu
|
||||
<img align="left" width="100" height="90" src="https://github.com/exercism/website-icons/blob/main/exercism/logo-big-bordered.png">
|
||||
|
||||
🌟🌟 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
|
||||
<br>
|
||||
|
||||
## 🚧 **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
|
||||
<p vertical-align="middle"><h2>In General</h2></p>
|
||||
<br>
|
||||
|
||||
- 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 `<exercise_slug>_test.py` file, the
|
||||
|
||||
_Exercise Structure with Auto-Generated Test Files_
|
||||
|
||||
```Bash
|
||||
```Graphql
|
||||
[<exercise-slug>/
|
||||
├── .docs
|
||||
│ └── instructions.md
|
||||
@@ -394,6 +397,7 @@ configlet generate <path/to/track> --spec-path path/to/problem/specifications
|
||||
<br>
|
||||
|
||||
|
||||
|
||||
[.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 <path/to/track> --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
|
||||
|
||||
@@ -26,7 +26,7 @@ Exercises are grouped into **concept** exercises which teach the [Python syllabu
|
||||
<img align="left" width="100" height="90" src="https://github.com/exercism/website-icons/blob/main/exercism/logo-big-bordered.png">
|
||||
|
||||
🌟🌟 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]**.
|
||||
|
||||
|
||||
<br>
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user