mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Update issue templates with GitHu default templates.
This commit is contained in:
parent
2b8bee3dda
commit
a909b629d8
35
.github/ISSUE_TEMPLATE.md
vendored
35
.github/ISSUE_TEMPLATE.md
vendored
@ -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>
|
|
32
.github/ISSUE_TEMPLATE/bug_report.md
vendored
32
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -1,8 +1,8 @@
|
|||||||
---
|
---
|
||||||
name: Bug report
|
name: Bug report
|
||||||
about: Create a report to help us improve
|
about: Create a report to help us improve
|
||||||
title: ''
|
title: '<what happen when you do on which document project>'
|
||||||
labels: ''
|
labels: 'bug'
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
@ -12,27 +12,27 @@ A clear and concise description of what the bug is.
|
|||||||
|
|
||||||
**To Reproduce**
|
**To Reproduce**
|
||||||
Steps to reproduce the behavior:
|
Steps to reproduce the behavior:
|
||||||
1. Go to '...'
|
```
|
||||||
2. Click on '....'
|
<Paste your command-line here which cause the problem>
|
||||||
3. Scroll down to '....'
|
```
|
||||||
4. See error
|
|
||||||
|
|
||||||
**Expected behavior**
|
**Expected behavior**
|
||||||
A clear and concise description of what you expected to happen.
|
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**
|
**Screenshots**
|
||||||
If applicable, add screenshots to help explain your problem.
|
If applicable, add screenshots to help explain your problem.
|
||||||
|
|
||||||
**Desktop (please complete the following information):**
|
**Environment info**
|
||||||
- OS: [e.g. iOS]
|
- OS: [e.g. Unix/Linux/Mac/Win/other with version]
|
||||||
- Browser [e.g. chrome, safari]
|
- Python version: [e.g. 3.7.1]
|
||||||
- Version [e.g. 22]
|
- Sphinx version: [e.g. 1.8.2]
|
||||||
|
- Extra tools: [e.g. Browser, tex or something else]
|
||||||
**Smartphone (please complete the following information):**
|
|
||||||
- Device: [e.g. iPhone6]
|
|
||||||
- OS: [e.g. iOS8.1]
|
|
||||||
- Browser [e.g. stock browser, safari]
|
|
||||||
- Version [e.g. 22]
|
|
||||||
|
|
||||||
**Additional context**
|
**Additional context**
|
||||||
Add any other context about the problem here.
|
Add any other context about the problem here.
|
||||||
|
|
||||||
|
- [e.g. URL or Ticket]
|
||||||
|
|
||||||
|
7
.github/ISSUE_TEMPLATE/feature_request.md
vendored
7
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@ -1,8 +1,8 @@
|
|||||||
---
|
---
|
||||||
name: Feature request
|
name: Feature request
|
||||||
about: Suggest an idea for this project
|
about: Suggest an idea for this project
|
||||||
title: ''
|
title: '<short description for the feature>'
|
||||||
labels: ''
|
labels: 'enhancement'
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
---
|
---
|
||||||
@ -18,3 +18,6 @@ A clear and concise description of any alternative solutions or features you've
|
|||||||
|
|
||||||
**Additional context**
|
**Additional context**
|
||||||
Add any other context or screenshots about the feature request here.
|
Add any other context or screenshots about the feature request here.
|
||||||
|
|
||||||
|
- [e.g. URL or Ticket]
|
||||||
|
|
||||||
|
17
.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
17
.github/ISSUE_TEMPLATE/question.md
vendored
Normal file
@ -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,
|
||||||
|
|
Loading…
Reference in New Issue
Block a user