Skip to content

Add issue template to avoid useless issues #2492

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Add issue template to avoid useless issues #2492

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d9add72
add issue template mentionning PEP 1
vpoulailleau Mar 31, 2022
65c92c1
add note from contributing guide
vpoulailleau Mar 31, 2022
39cb2d2
clarify that this is for bugs on PEPs
vpoulailleau Mar 31, 2022
15941fd
add titles for guidance
vpoulailleau Mar 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
Issue tracker is **ONLY** used for reporting bugs on documents (PEPs), not
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Issue tracker is **ONLY** used for reporting bugs on documents (PEPs), not
This issue tracker is **ONLY** used for reporting bugs on documents (PEPs), not

bugs in Python.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could link to https://devguide.python.org/tracker/ as the place to report bugs in Python (and let's call it CPython).


New features should be discussed according to the following process:
[PEP 1](https://peps.python.org/pep-0001/#start-with-an-idea-for-python)
Comment on lines +4 to +5
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
New features should be discussed according to the following process:
[PEP 1](https://peps.python.org/pep-0001/#start-with-an-idea-for-python)
New features should be discussed according to
[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.

<!--- Provide a general summary of the issue in the Title above -->

### What did you spot, and where?

### What did you expect to be changed?

### Why?
Comment on lines +19 to +23
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a bit of space for text entry:

Suggested change
### What did you spot, and where?
### What did you expect to be changed?
### Why?
### What did you spot, and where?
### What did you expect to be changed?
### Why?