diff options
author | shimizukawa <shimizukawa@gmail.com> | 2019-01-13 16:59:04 +0900 |
---|---|---|
committer | shimizukawa <shimizukawa@gmail.com> | 2019-01-13 16:59:04 +0900 |
commit | ee92e84d3f07f05eaec4fdcdb600f9f7c245517d (patch) | |
tree | 0cea693458c797c6a16321e2779550aa10958677 /.github | |
parent | a909b629d8837479d9e654ff2ad80a3602cb2242 (diff) | |
download | sphinx-git-ee92e84d3f07f05eaec4fdcdb600f9f7c245517d.tar.gz |
Improve issue templates for bug reporting.
Diffstat (limited to '.github')
-rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index aa3226609..146f3b6bc 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -14,6 +14,13 @@ A clear and concise description of what the bug is. 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** @@ -29,6 +36,7 @@ If applicable, add screenshots to help explain your problem. - 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** |