From 8a808952a61b4bd572d95f5efbff1680c59aa507 Mon Sep 17 00:00:00 2001 From: Mariatta Wijaya Date: Fri, 22 Jul 2022 09:19:08 -0700 Subject: [PATCH] Use Markdown Headers in GitHub Issue templates (GH-95111) The Issue templates are using the markup to make text bold. We should be using proper text headers instead. I replaced the **bold** text markup with L1 headers. --- .github/ISSUE_TEMPLATE/bug.md | 4 ++-- .github/ISSUE_TEMPLATE/crash.md | 6 +++--- .github/ISSUE_TEMPLATE/documentation.md | 2 +- .github/ISSUE_TEMPLATE/feature.md | 6 +++--- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md index 7bdca2112b2..1d93e0735e5 100644 --- a/.github/ISSUE_TEMPLATE/bug.md +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -15,12 +15,12 @@ labels: "type-bug" your problem has already been reported --> -**Bug report** +# 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** +# Your environment diff --git a/.github/ISSUE_TEMPLATE/crash.md b/.github/ISSUE_TEMPLATE/crash.md index 28d7bfec193..dad3423db03 100644 --- a/.github/ISSUE_TEMPLATE/crash.md +++ b/.github/ISSUE_TEMPLATE/crash.md @@ -13,15 +13,15 @@ labels: "type-crash" For CPython, a "crash" is when Python itself fails, leading to a traceback in the C stack. --> -**Crash report** +# Crash report Tell us what happened, ideally including a minimal, reproducible example (https://stackoverflow.com/help/minimal-reproducible-example). -**Error messages** +# Error messages Enter any relevant error message caused by the crash, including a core dump if there is one. -**Your environment** +# Your environment diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index 669c92adb47..174fd39171d 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -4,6 +4,6 @@ about: Report a problem with the documentation labels: "docs" --- -**Documentation** +# Documentation (A clear and concise description of the issue.) diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md index 635ea43545f..ed051e945f8 100644 --- a/.github/ISSUE_TEMPLATE/feature.md +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -4,16 +4,16 @@ about: Submit a proposal for a new CPython feature or enhancement labels: "type-feature" --- -**Feature or enhancement** +# Feature or enhancement (A clear and concise description of your proposal.) -**Pitch** +# Pitch (Explain why this feature or enhancement should be implemented and how it would be used. Add examples, if applicable.) -**Previous discussion** +# Previous discussion