From 54d62483bfe801ca863763ed47c9cee95e6207f3 Mon Sep 17 00:00:00 2001 From: Aaron Carlisle Date: Tue, 23 Jan 2018 10:24:47 -0500 Subject: [PATCH] Add GitHub templates (#410) * Add issue template * Move contributing docs into there own file * Delete CONTRIBUTING.md * Address Review - Style the code block with `rst` - Add python version --- .github/ISSUE_TEMPLATE.md | 26 ++++++++++++++++++++++++++ README.rst | 11 +---------- 2 files changed, 27 insertions(+), 10 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 00000000..fc328114 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,26 @@ + +### Problem + +Give details on your issue. + +### Reproducible Project + +Please give a link to a public reproducible project or provide an example of the Restructured Text that gives an issue. + +```rst +Place RST code here (if any). +``` + +#### Error Logs/Results + +Place any images or error logs that might be able to help solve the issue here. + +#### Expected Results + +Please describe how this should work properly. + +### Environment Info + +- Python Version: +- Sphinx Version: +- RTD Theme Version: diff --git a/README.rst b/README.rst index 6de1163f..c00f7479 100644 --- a/README.rst +++ b/README.rst @@ -246,6 +246,7 @@ By default, the navigation will "stick" to the screen as you scroll. However if is vertically too large, it will revert to static positioning. To disable the sticky nav altogether change the setting in ``conf.py``. + Contributing or modifying the theme =================================== @@ -299,16 +300,6 @@ This default task will do the following **very cool things that make it worth th #. Rebuild the sphinx docs anytime it notices a change to ``.rst``, ``.html``, ``.js`` or ``.css`` files. -Before you create an issue --------------------------- - -I don't have a lot of time to maintain this project due to other responsibilities. -I know there are a lot of Python engineers out there that can't code sass / css and -are unable to submit pull requests. That said, submitting random style bugs without -at least providing sample documentation that replicates your problem is a good -way for me to ignore your request. RST unfortunately can spit out a lot of things -in a lot of ways. I don't have time to research your problem for you, but I do -have time to fix the actual styling issue if you can replicate the problem for me. Releasing the Theme ===================