Skip to content

Commit 9094935

Browse files
authored
chore: new issues templates (jxmorris12#201)
1 parent 63c1457 commit 9094935

3 files changed

Lines changed: 80 additions & 0 deletions

File tree

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Documentation improvement
3+
about: Report missing, incorrect, or unclear documentation
4+
title: "[DOCS]"
5+
labels: documentation
6+
7+
---
8+
9+
## What is the issue with the current documentation?
10+
Describe what is missing, wrong, or unclear. Include a link or path to the affected page/section if possible.
11+
12+
## Where is the problem located?
13+
- [ ] README
14+
- [ ] Sphinx / API reference (`docs/`)
15+
- [ ] Docstring in source code
16+
- [ ] CHANGELOG
17+
- [ ] Other: <!-- please specify -->
18+
19+
## Suggested improvement
20+
Describe what should be added, corrected, or clarified. If you have a draft, paste it here.
21+
22+
## Additional context
23+
Add any relevant references (e.g. LanguageTool upstream docs, related issues) here.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Feature request
3+
about: Suggest a new feature or improvement
4+
title: "[FEATURE]"
5+
labels: enhancement
6+
7+
---
8+
9+
# A short title describing the feature you'd like
10+
11+
## Problem or motivation
12+
What problem does this feature solve? What use case are you trying to cover?
13+
14+
## Proposed solution
15+
Describe the feature you'd like and how you'd expect it to work.
16+
17+
```python
18+
# If applicable, show what the API could look like
19+
import language_tool_python
20+
tool = language_tool_python.LanguageTool('en-US')
21+
# ...
22+
```
23+
24+
## Alternatives considered
25+
Have you found any workarounds or other approaches? Why are they not sufficient?
26+
27+
## Additional context
28+
Add any relevant links, references to LanguageTool's own API/docs, or other context here.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Question / Support
3+
about: Ask a question about using language_tool_python
4+
title: "[QUESTION]"
5+
labels: question
6+
7+
---
8+
9+
> **Before opening an issue**, please check:
10+
> - The [README](https://github.com/jxmorris12/language_tool_python#readme) and [documentation](https://language-tool-python.readthedocs.io)
11+
> - Existing [issues](https://github.com/jxmorris12/language_tool_python/issues?q=is%3Aissue)
12+
13+
## Your question
14+
A clear and concise description of what you are trying to do or understand.
15+
16+
## What you have tried
17+
18+
```python
19+
# Paste the relevant code snippet here
20+
```
21+
22+
## Execution environment
23+
- OS: [e.g. Windows 11, Ubuntu 22.04]
24+
- Python version: [e.g. 3.11]
25+
- Package version: [e.g. 2.9.5]
26+
- Installation method: [e.g. pip, conda]
27+
28+
## Additional context
29+
Add any error messages, logs, or other context that might help.

0 commit comments

Comments
 (0)