From 8f105a441dff397a72c9f3e54f73850b31eafdb6 Mon Sep 17 00:00:00 2001 From: iomintz <io@mintz.cc> Date: Fri, 18 Sep 2020 06:40:27 -0500 Subject: [PATCH] issue/PR templates: use h2 instead of h3 `h2` is the semantically correct heading here, as `h1` is for document titles and `h2` is for the top level headings within a document. `h3` should be used for subheadings of `h2` headings. --- .github/ISSUE_TEMPLATE/bug_report.md | 12 ++++++------ .github/ISSUE_TEMPLATE/feature_request.md | 8 ++++---- .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index aa73aa159..fa9492450 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,24 +4,24 @@ about: Report broken or incorrect behaviour labels: bug --- -### Summary +## Summary <!-- A summary of your bug report --> -### Reproduction Steps +## Reproduction Steps <!-- What you did to make it happen. Ideally there should be a short code snippet in this section to help reproduce the bug. --> -### Expected Results +## Expected Results <!-- What you expected to happen --> -### Actual Results +## Actual Results <!-- What actually happened. If there is a traceback, please show the entire thing. --> -### Checklist +## Checklist <!-- Put an x inside [ ] to check it, like so: [x] --> @@ -29,7 +29,7 @@ labels: bug - [ ] I have shown the entire traceback, if possible. - [ ] I have removed my token from display, if visible. -### System Information +## System Information <!-- Run `python -m discord -v` and paste this information below. --> <!-- This command is available in v1.1.0 or higher. If you are unable to run this command, paste basic info (ie. Python version, library version, and your operating system --> diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 95dea663d..4badd49ee 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -4,24 +4,24 @@ about: Suggest a feature for this library labels: feature request --- -### The Problem +## The Problem <!-- What problem is your feature trying to solve? What becomes easier or possible when this feature is implemented? --> -### The Ideal Solution +## The Ideal Solution <!-- What is your ideal solution to the problem? What would you like this feature to do? --> -### The Current Solution +## The Current Solution <!-- What is the current solution to the problem, if any? --> -### Summary +## Summary <!-- A short summary of your feature request. --> diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e39c651da..55941f4e1 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,8 +1,8 @@ -### Summary +## Summary <!-- What is this pull request for? Does it fix any issues? --> -### Checklist +## Checklist <!-- Put an x inside [ ] to check it, like so: [x] -->