diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 0000000..c42f8b5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,23 @@ +--- +name: Documentation improvement +about: Report missing, incorrect, or unclear documentation +title: "[DOCS]" +labels: documentation + +--- + +## What is the issue with the current documentation? +Describe what is missing, wrong, or unclear. Include a link or path to the affected page/section if possible. + +## Where is the problem located? +- [ ] README +- [ ] Sphinx / API reference (`docs/`) +- [ ] Docstring in source code +- [ ] CHANGELOG +- [ ] Other: + +## Suggested improvement +Describe what should be added, corrected, or clarified. If you have a draft, paste it here. + +## Additional context +Add any relevant references (e.g. LanguageTool upstream docs, related issues) here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..63aa775 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,28 @@ +--- +name: Feature request +about: Suggest a new feature or improvement +title: "[FEATURE]" +labels: enhancement + +--- + +# A short title describing the feature you'd like + +## Problem or motivation +What problem does this feature solve? What use case are you trying to cover? + +## Proposed solution +Describe the feature you'd like and how you'd expect it to work. + +```python +# If applicable, show what the API could look like +import language_tool_python +tool = language_tool_python.LanguageTool('en-US') +# ... +``` + +## Alternatives considered +Have you found any workarounds or other approaches? Why are they not sufficient? + +## Additional context +Add any relevant links, references to LanguageTool's own API/docs, or other context here. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..2477b3f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,29 @@ +--- +name: Question / Support +about: Ask a question about using language_tool_python +title: "[QUESTION]" +labels: question + +--- + +> **Before opening an issue**, please check: +> - The [README](https://github.com/jxmorris12/language_tool_python#readme) and [documentation](https://language-tool-python.readthedocs.io) +> - Existing [issues](https://github.com/jxmorris12/language_tool_python/issues?q=is%3Aissue) + +## Your question +A clear and concise description of what you are trying to do or understand. + +## What you have tried + +```python +# Paste the relevant code snippet here +``` + +## Execution environment +- OS: [e.g. Windows 11, Ubuntu 22.04] +- Python version: [e.g. 3.11] +- Package version: [e.g. 2.9.5] +- Installation method: [e.g. pip, conda] + +## Additional context +Add any error messages, logs, or other context that might help.