]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Use Markdown Headers in GitHub Issue templates (GH-95111)
authorMariatta Wijaya <Mariatta@users.noreply.github.com>
Fri, 22 Jul 2022 16:19:08 +0000 (09:19 -0700)
committerGitHub <noreply@github.com>
Fri, 22 Jul 2022 16:19:08 +0000 (09:19 -0700)
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
.github/ISSUE_TEMPLATE/crash.md
.github/ISSUE_TEMPLATE/documentation.md
.github/ISSUE_TEMPLATE/feature.md

index 7bdca2112b287b9929357d5713f47eca51529642..1d93e0735e50f33a73e96df998745f51b7140157 100644 (file)
@@ -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
 
 <!-- Include as many relevant details as possible about the environment you experienced the bug in -->
 
index 28d7bfec193814fc35c75ed3e5d387146fc9fb71..dad3423db03410f65eca1c7ca4e2929c3a4a73e5 100644 (file)
@@ -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
 
 <!-- Include as many relevant details as possible about the environment you experienced the bug in -->
 
index 669c92adb475318628e051da4cc9105a689924d4..174fd39171d47dd24806f13c1e76a38b3f1c9f90 100644 (file)
@@ -4,6 +4,6 @@ about: Report a problem with the documentation
 labels: "docs"
 ---
 
-**Documentation**
+# Documentation
 
 (A clear and concise description of the issue.)
index 635ea43545f4971e8f50d609da1698300b0619ca..ed051e945f81207acaf501c5d8d620746fb819b8 100644 (file)
@@ -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
 
 <!--
   New features to Python should first be discussed elsewhere before creating issues on GitHub,