From 1169b0b3ca1812b97382ee16a2fad4b0e7506eaf Mon Sep 17 00:00:00 2001 From: Alex Waygood Date: Sat, 16 Apr 2022 02:20:54 +0100 Subject: Add minimal issue templates (#91569) * Add minimal issue templates * Wording tweaks * Apply suggestions from code review Co-authored-by: Hugo van Kemenade * Improve words in `security` template * Update bug.md * Update crash.md * Add link to security vulnerability website from first page * Never edit on your phone * Apply suggestions from code review Co-authored-by: Hugo van Kemenade * Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: Hugo van Kemenade * Apply suggestions from code review Co-authored-by: Hugo van Kemenade * Apply suggestions from code review Co-authored-by: Ezio Melotti Co-authored-by: Erlend Egeberg Aasland * There might not be a traceback if there's a crash Co-authored-by: Ezio Melotti * Update .github/ISSUE_TEMPLATE/config.yml Co-authored-by: Ezio Melotti * Reorder `config.yml` file * Fix Erlend's nits * version -> architecture * Apply suggestions from code review Co-authored-by: Ezio Melotti Co-authored-by: Hugo van Kemenade Co-authored-by: Ezio Melotti Co-authored-by: Erlend Egeberg Aasland --- .github/ISSUE_TEMPLATE/bug.md | 32 ++++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 10 ++++++++++ .github/ISSUE_TEMPLATE/crash.md | 33 +++++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/documentation.md | 9 +++++++++ .github/ISSUE_TEMPLATE/feature.md | 28 ++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/security.md | 25 +++++++++++++++++++++++++ 6 files changed, 137 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/crash.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/feature.md create mode 100644 .github/ISSUE_TEMPLATE/security.md diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000..7bdca21 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Submit a bug report +labels: "type-bug" +--- + + + +**Bug report** + +A clear and concise description of what the bug is. +Include a minimal, reproducible example (https://stackoverflow.com/help/minimal-reproducible-example), if possible. + +**Your environment** + + + +- CPython versions tested on: +- Operating system and architecture: + + diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..547c724 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,10 @@ +contact_links: + - name: "Getting help" + about: "Ask questions about using Python and debugging errors on Discourse." + url: "https://discuss.python.org/c/users/7" + - name: "Proposing new features" + about: "Submit major feature proposal (e.g. syntax changes) to an ideas forum first." + url: "https://discuss.python.org/c/ideas/6" + - name: "Reporting security vulnerabilities" + about: "See here for details on reporting security vulnerabilities in CPython" + url: "https://www.python.org/dev/security/" diff --git a/.github/ISSUE_TEMPLATE/crash.md b/.github/ISSUE_TEMPLATE/crash.md new file mode 100644 index 0000000..28d7bfe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/crash.md @@ -0,0 +1,33 @@ +--- +name: Crash report +about: A hard crash of the interpreter, possibly with a core dump +labels: "type-crash" +--- + + + +**Crash report** + +Tell us what happened, ideally including a minimal, reproducible example (https://stackoverflow.com/help/minimal-reproducible-example). + +**Error messages** + +Enter any relevant error message caused by the crash, including a core dump if there is one. + +**Your environment** + + + +- CPython versions tested on: +- Operating system and architecture: + + diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..669c92a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,9 @@ +--- +name: Documentation +about: Report a problem with the documentation +labels: "docs" +--- + +**Documentation** + +(A clear and concise description of the issue.) diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 0000000..75ef03b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,28 @@ +--- +name: Feature or enhancement +about: Submit a proposal for a new CPython feature or enhancement +labels: "type-feature" +--- + +**Feature or enhancement** + +(A clear and concise description of your proposal.) + +**Pitch** + +(Explain why this feature or enhacement should be implemented and how it would be used. + Add examples, if applicable.) + +**Previous discussion** + + + + + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/security.md b/.github/ISSUE_TEMPLATE/security.md new file mode 100644 index 0000000..fd45cae --- /dev/null +++ b/.github/ISSUE_TEMPLATE/security.md @@ -0,0 +1,25 @@ +--- +name: Security vulnerability report +about: Submit a report regarding a security vulnerability +labels: "type-security" +--- + + + +**Security vulnerability report** + +A description of what the security vulnerability is. + +**Your environment** + + + +- CPython versions tested on: +- Operating system and architecture: + + -- cgit v0.12