Merge pull request #5942 from sphinx-doc/multiple-issue-templates

Update issue templates

.github/ISSUE_TEMPLATE.md

@@ -1,35 +0,0 @@
-Subject: <what happen when you do on which document project>
-
-<!--
-  Important: This is a list of issues for Sphinx, not a forum.
-  If you'd like to post a question, please move to sphinx-users group.
-  https://groups.google.com/forum/#!forum/sphinx-users
-
-  Thanks,
--->
-
-### Problem
-- <Detail of problem>
-
-#### Procedure to reproduce the problem
-```
-<Paste your command-line here which cause the problem>
-```
-
-#### Error logs / results
-```
-<Paste your error log here>
-```
-- <public link of unexpected result if you have>
-
-#### Expected results
-<Describe what to actually do>
-
-### Reproducible project / your project
-- <link to your project, or attach zipped small project sample>
-
-### Environment info
-- OS: <Unix/Linux/Mac/Win/other with version>
-- Python version:
-- Sphinx version:
-- <Extra tools e.g.: Browser, tex or something else>

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,46 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: '<what happen when you do on which document project>'
+labels: 'bug'
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+```
+<Paste your command-line here which cause the problem>
+
+$ git clone htps://github.com/.../some_project
+$ cd some_project
+$ pip install -r requirements.txt
+$ cd docs
+$ make html SPHINXOPTS="-D language=de"
+$ # open _build/html/index and see bla bla
+```
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Your project**
+Link to your sphinx project, or attach zipped small project sample.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment info**
+- OS: [e.g. Unix/Linux/Mac/Win/other with version]
+- Python version: [e.g. 3.7.1]
+- Sphinx version: [e.g. 1.8.2]
+- Sphinx extensions:  [e.g. sphinx.ext.autodoc, recommonmark]
+- Extra tools: [e.g. Browser, tex or something else]
+
+**Additional context**
+Add any other context about the problem here.
+
+- [e.g. URL or Ticket]
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: '<short description for the feature>'
+labels: 'enhancement'
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.
+
+- [e.g. URL or Ticket]
+

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,17 @@
+---
+name: Question
+about: For Q&A purpose, please use https://groups.google.com/forum/#!forum/sphinx-users
+title: For Q&A purpose, please use sphinx-users group
+labels: 'question'
+assignees: ''
+
+---
+
+# Important
+
+This is a list of issues for Sphinx, **not a forum**.
+If you'd like to post a question, please move to sphinx-users group.
+https://groups.google.com/forum/#!forum/sphinx-users
+
+Thanks,
+