From d9add721eacbf2d3ece92c04e682189ed5b16d9d Mon Sep 17 00:00:00 2001 From: Vincent Poulailleau Date: Thu, 31 Mar 2022 11:07:10 +0200 Subject: [PATCH 1/4] add issue template mentionning PEP 1 --- .github/ISSUE_TEMPLATE.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000000..bcd9f7b7803 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,8 @@ +Issue tracker is **ONLY** used for reporting bugs. + +New features should be discussed according to the following process: +[PEP 1](https://peps.python.org/pep-0001/#start-with-an-idea-for-python) + + + + From 65c92c107ac5943274ea7a2cb7fa4b7d6b59a7c6 Mon Sep 17 00:00:00 2001 From: Vincent Poulailleau Date: Thu, 31 Mar 2022 11:14:57 +0200 Subject: [PATCH 2/4] add note from contributing guide --- .github/ISSUE_TEMPLATE.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index bcd9f7b7803..951b094e78c 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -3,6 +3,16 @@ Issue tracker is **ONLY** used for reporting bugs. New features should be discussed according to the following process: [PEP 1](https://peps.python.org/pep-0001/#start-with-an-idea-for-python) +And according to [Contributing Guide](../CONTRIBUTING.rst): + +While fixing spelling mistakes as part of more substantive +copyediting and proofreading of draft and active PEPs is okay, +we generally advise against PRs that simply mass-correct minor typos on +older PEPs that don't significantly impair meaning and understanding, +as these tend to create a fairly high level of noise and churn for +PEP readers, authors and editors relative to the amount of practical value +they provide. + From 39cb2d23e708c51d73c4a71aecea2bcb1a6c5851 Mon Sep 17 00:00:00 2001 From: Vincent Poulailleau Date: Thu, 31 Mar 2022 15:38:35 +0200 Subject: [PATCH 3/4] clarify that this is for bugs on PEPs --- .github/ISSUE_TEMPLATE.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 951b094e78c..708b5a33aa3 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,4 +1,5 @@ -Issue tracker is **ONLY** used for reporting bugs. +Issue tracker is **ONLY** used for reporting bugs on documents (PEPs), not +bugs in Python. New features should be discussed according to the following process: [PEP 1](https://peps.python.org/pep-0001/#start-with-an-idea-for-python) From 15941fd8de28e81e04519accc92e51a9bb7e73da Mon Sep 17 00:00:00 2001 From: Vincent Poulailleau Date: Thu, 31 Mar 2022 15:41:29 +0200 Subject: [PATCH 4/4] add titles for guidance --- .github/ISSUE_TEMPLATE.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 708b5a33aa3..f2ceafae88a 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -16,4 +16,8 @@ they provide. - +### What did you spot, and where? + +### What did you expect to be changed? + +### Why?