Skip to content

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

feat: issue templates

Elijah Pottercb7f7969080b
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 000000000..c12f526c4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Platform**
+What platform has the issue? Is it in Obsidian, Neovim, or Visual Studio Code? Something else?
+
+**Additional context**
+Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/report-grammatical-error.md b/.github/ISSUE_TEMPLATE/report-grammatical-error.md
new file mode 100644
index 000000000..29243d914
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/report-grammatical-error.md
@@ -0,0 +1,20 @@
+---
+name: Report Grammatical Error
+about: If a grammatical error is not found by Harper, let us tus now
+title: ''
+labels: enhancement, harper-core, linting
+assignees: ''
+
+---
+
+## Description
+
+Give a detailed description of the grammatical error Harper should be able to find.
+
+## Resources
+
+If there are any resources online we can reference that described grammatical rules, let us know.
+
+## Examples
+
+Please provide at least three examples of the grammatical error in real text.