Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/sphinx-doc/sphinx.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTakayuki SHIMIZUKAWA <shimizukawa@gmail.com>2021-06-16 23:30:00 +0300
committerTakeshi KOMIYA <i.tkomiya@gmail.com>2021-07-06 16:46:56 +0300
commit748bdcc373cf28f6917a20f9ebb6acf5630760e2 (patch)
tree6fa2827752f431776d9351c69659e0379474f316 /.github
parentb2fa77c8f0dde52ee76e4a8f8079552b9dd52071 (diff)
using new issue template feature in yaml configuration
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md46
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yml96
2 files changed, 96 insertions, 46 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 0fa6b61fe..000000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,46 +0,0 @@
----
-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 https://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]
-
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 000000000..4f4be1647
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,96 @@
+name: Bug report
+description: Something is not working correctly.
+title: "<what happen when you do on which document project>"
+labels: "bug"
+assignees: ""
+
+body:
+ - type: textarea
+ attributes:
+ label: Describe the bug
+ description: >-
+ A clear and concise description of what the bug is.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: How to Reproduce
+ description: Please provide steps to reproduce this bug.
+ value: |
+ <Paste your command-line here which cause the problem>
+ ```
+ $ git clone https://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
+ ```
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Expected behavior
+ description: >-
+ A clear and concise description of what you expected to happen.
+
+ - type: input
+ attributes:
+ label: Your project
+ description: >-
+ Link to your sphinx project, or attach zipped small project sample.
+ validations:
+ required: true
+
+ - type: textarea
+ attributes:
+ label: Screenshots
+ description: >-
+ If applicable, add screenshots to help explain your problem.
+ validations:
+ required: false
+
+ - type: markdown
+ attributes:
+ value: |
+ ## Environment info
+
+ - type: input
+ attributes:
+ label: OS
+ description: >-
+ [e.g. Unix/Linux/Mac/Win/other with version]
+ validations:
+ required: true
+ - type: input
+ attributes:
+ label: Python version
+ validations:
+ required: true
+ - type: input
+ attributes:
+ label: Sphinx version
+ validations:
+ required: true
+ - type: input
+ attributes:
+ label: Sphinx extensions
+ description: >-
+ [e.g. sphinx.ext.autodoc, recommonmark]
+ validations:
+ required: false
+ - type: input
+ attributes:
+ label: Extra tools
+ description: >-
+ [e.g. Browser, tex or something else]
+ validations:
+ required: false
+ - type: textarea
+ attributes:
+ label: Additional context
+ description: >-
+ Add any other context about the problem here.
+ [e.g. URL or Ticket]