From a909b629d8837479d9e654ff2ad80a3602cb2242 Mon Sep 17 00:00:00 2001 From: Takayuki SHIMIZUKAWA Date: Sun, 13 Jan 2019 16:15:03 +0900 Subject: [PATCH] Update issue templates with GitHu default templates. --- .github/ISSUE_TEMPLATE.md | 35 ----------------------- .github/ISSUE_TEMPLATE/bug_report.md | 32 ++++++++++----------- .github/ISSUE_TEMPLATE/feature_request.md | 7 +++-- .github/ISSUE_TEMPLATE/question.md | 17 +++++++++++ 4 files changed, 38 insertions(+), 53 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index a863f2888..000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,35 +0,0 @@ -Subject: - - - -### Problem -- - -#### Procedure to reproduce the problem -``` - -``` - -#### Error logs / results -``` - -``` -- - -#### Expected results - - -### Reproducible project / your project -- - -### Environment info -- OS: -- Python version: -- Sphinx version: -- diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea782..aa3226609 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,8 +1,8 @@ --- name: Bug report about: Create a report to help us improve -title: '' -labels: '' +title: '' +labels: 'bug' assignees: '' --- @@ -12,27 +12,27 @@ A clear and concise description of what the bug is. **To Reproduce** Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +``` + +``` **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. -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**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] +**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] +- 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/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7d6..b78fef7e2 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,8 +1,8 @@ --- name: Feature request about: Suggest an idea for this project -title: '' -labels: '' +title: '' +labels: 'enhancement' assignees: '' --- @@ -18,3 +18,6 @@ A clear and concise description of any alternative solutions or features you've **Additional context** Add any other context or screenshots about the feature request here. + +- [e.g. URL or Ticket] + diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 000000000..712676950 --- /dev/null +++ b/.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, +