summaryrefslogtreecommitdiffstats
path: root/.github/ISSUE_TEMPLATE
diff options
context:
space:
mode:
Diffstat (limited to '.github/ISSUE_TEMPLATE')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md28
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md20
2 files changed, 48 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..6bbe40a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: Needs triage
+assignees: ""
+---
+
+**Read the docs**
+You might find a solution to your problem in the [docs](https://rich.readthedocs.io/en/latest/introduction.html) -- consider using the search function there.
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+A minimal code example that reproduces the problem would be a big help if you can provide it. If the issue is visual in nature, consider posting a screenshot.
+
+**Platform**
+What platform (Win/Linux/Mac) are you running on? What terminal software are you using?
+
+**Diagnose**
+I may ask you to cut and paste the output of the following commands. It may save some time if you do it now.
+
+```
+python -m rich.diagnose
+python -m rich._windows
+pip freeze | grep rich
+```
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..ab4de71
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[REQUEST]"
+labels: Needs triage
+assignees: ''
+
+---
+
+Consider posting in https://github.com/willmcgugan/rich/discussions for feedback before raising a feature request.
+
+Have you checked the issues for a similar suggestions?
+
+**How would you improve Rich?**
+
+Give as much detail as you can. Example code of how you would like it to work would help.
+
+**What problem does it solved for you?**
+
+What problem do you have that this feature would solve? I may be able to suggest an existing way of solving it.