Skip to content

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

template for feature requests on github

hippietrail5ce641b5f213
diff --git a/.github/ISSUE_TEMPLATE/suggest-a-feature.md b/.github/ISSUE_TEMPLATE/suggest-a-feature.md
new file mode 100644
index 000000000..06a4d3682
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/suggest-a-feature.md
@@ -0,0 +1,50 @@
+---
+name: Suggest a Feature
+about: Suggest a new feature for Harper to improve its functionality
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+## Note
+
+This template is for suggesting new features for Harper. If you want to report a grammatical error that Harper doesn't detect, please use the [Report Grammatical Error](https://github.com/Automattic/harper/issues/new?template=report-grammatical-error.md)
+template instead.
+
+## Description
+
+Provide a detailed description of the feature you would like to see in Harper. Explain what problem it would solve or what benefit it would bring to users.
+
+## Component
+
+Which component of Harper would this feature affect? For example:
+- Core grammar checking engine
+- Obsidian plugin
+- VS Code extension
+- Neovim plugin
+- WebAssembly version
+- Another component
+
+## Use Cases
+
+Describe specific scenarios where this feature would be useful. Include examples of text or situations where this feature would be particularly beneficial.
+
+## Implementation Ideas
+
+If you have any ideas about how this feature could be implemented, please share them. Consider:
+- What kind of rules or patterns would need to be detected?
+- Would it require new data structures or algorithms?
+- Are there any existing tools or libraries that could be leveraged?
+
+## Existing Solutions
+
+If similar functionality exists in other grammar checkers or tools, mention them and explain how your proposed feature would differ or improve upon them.
+
+## Screenshots/Examples
+
+If applicable, add screenshots or examples to help illustrate the feature you're suggesting.
+
+## Additional Context
+
+Add any other context or considerations that would be helpful for implementing this feature.
\ No newline at end of file