Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

docs: use level 2 headings in GitHub templates (#4819)

Gary Jones2c140cfb3b6d
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 6c74754a6..5347d3d08 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -7,24 +7,24 @@ assignees: ''
---
-**Describe the bug**
+## Describe the bug
A clear and concise description of what the bug is.
-**To Reproduce**
+## To Reproduce
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
-**Expected behavior**
+## Expected behavior
A clear and concise description of what you expected to happen.
-**Screenshots**
+## Screenshots
If applicable, add screenshots to help explain your problem.
-**Platform**
+## Platform
What platform has the issue? Is it in Obsidian, Chrome or Firefox, Visual Studio Code, the Desktop app, Neovim, or something else?
-**Additional context**
+## Additional context
Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/report-false-positive.md b/.github/ISSUE_TEMPLATE/report-false-positive.md
index d83fd901f..1a6a068c0 100644
--- a/.github/ISSUE_TEMPLATE/report-false-positive.md
+++ b/.github/ISSUE_TEMPLATE/report-false-positive.md
@@ -4,11 +4,11 @@ about: Harper flagged something that's actually correct
title: ''
labels: bug, harper-core, linting, false-positive
---
-**What got flagged?**
+## What got flagged?
The text that was incorrectly flagged.
-**Why is this incorrect?**
+## Why is this incorrect?
Brief explanation.
-**Example of correct usage:**
+## Example of correct usage
[Your example here]
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/report-grammatical-error.md b/.github/ISSUE_TEMPLATE/report-grammatical-error.md
index 9bc1a63f1..3eb6b25e3 100644
--- a/.github/ISSUE_TEMPLATE/report-grammatical-error.md
+++ b/.github/ISSUE_TEMPLATE/report-grammatical-error.md
@@ -4,15 +4,15 @@ about: Harper missed a grammatical error
title: ''
labels: enhancement, harper-core, linting
---
-**The Error**
+## The Error
Description of the error.
-**Examples (2-3):**
+## Examples (2-3)
1.
2.
-**References**
+## References
Any grammar rules or resources that support this.
-**Potential Edge Cases**
+## Potential Edge Cases
When might this not apply?
\ No newline at end of file
diff --git a/.github/ISSUE_TEMPLATE/suggest-a-feature.md b/.github/ISSUE_TEMPLATE/suggest-a-feature.md
index b896e48c2..bba102541 100644
--- a/.github/ISSUE_TEMPLATE/suggest-a-feature.md
+++ b/.github/ISSUE_TEMPLATE/suggest-a-feature.md
@@ -4,19 +4,19 @@ about: Propose a new feature
title: ''
labels: enhancement
---
-**What problem does this solve?**
+## What problem does this solve?
Brief description.
-**Proposed Solution**
+## Proposed Solution
How should it work?
-**Examples**
+## Examples
Show, don't tell.
-**Component**
+## Component
- [ ] Core engine
- [ ] Plugin/Extension
- [ ] Other: _____
-**Additional Context**
+## Additional Context
Any other relevant info.
\ No newline at end of file
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 799917361..f1e893471 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,20 +1,20 @@
<!-- If you are an agent or using an agent, please read https://elijahpotter.dev/articles/harper's-policy-on-agent-PRs first-->
-# Issues
+## Issues
<!-- Link any relevant GitHub issues here. -->
<!-- If this PR resolves the issue(s), write closes/fixes/resolves before the issue number(s) (e.g. Fixes #____, closes #____). -->
-# Description
+## Description
<!-- Please include a summary of the change. -->
<!-- Any details that you think are important to review this PR? -->
<!-- Are there other PRs related to this one? -->
-# Demo
+## Demo
<!-- Add a screenshot or a video demonstration when possible and necessary. -->
-# How Has This Been Tested?
+## How Has This Been Tested?
<!-- Please describe how you tested your changes. -->
-# AI Disclosure
+## AI Disclosure
<!-- It helps us review PRs when we know about AI assistance. -->
- [ ] I am a human and didn't use any AI.
- [ ] I used LLM features of my editor, but not an agent.
@@ -22,14 +22,14 @@
- [ ] I used an AI agent interactively.
- [ ] I am an agent or I got an agent to do the work autonomously.
-# If Your PR Implements or Enhances a Linter
+## If Your PR Implements or Enhances a Linter
<!-- Humans don't always bring ideal test cases, but unlike AIs, they can learn how to find real-world examples -->
- [ ] I made up the sentences in the unit tests.
- [ ] The sentences in the unit tests were generated by an AI.
- [ ] I'm using examples from the bug report / feature request.
- [ ] I collected real-world sentences for the unit tests.
-# Checklist
+## Checklist
<!-- Go over all the following points, and put an `x` in all the boxes that apply -->
- [ ] I have performed a self-review of my own code
- [ ] I have added tests to cover my changes