Update to github issue and PR templates (#1087)

Zulko · Feb 22, 2020 · 8126e62 · 8126e62
1 parent 6403c09
commit 8126e62
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 7 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,8 +1,16 @@
 <!--
-Thank you for submitting this issue! If you are not reporting a bug, please delete all of the following text.
-If you are reporting a bug, please ensure moviepy is updated to the latest version before submitting, as some bugs may only be present on older versions.
+Thank you for submitting this issue!
+If you are *not* reporting a bug, please delete all of the following text.
+If you *are* reporting a bug, please ensure that moviepy is updated to the latest version before submitting, as some bugs may only be present on older versions.
 
-You can format code by putting ``` (that's 3 backticks) on a line by itself at the beginning and end of each code block.
+You can format code by putting ``` (that's 3 backticks) on a line by itself at the beginning and end of each code block. For example:
+
+```
+from moviepy.editor import *
+
+clip = ColorClip((600, 400), color=(255, 100, 0), duration=2)
+clip.write_videofile("colorclip.mp4", fps=24)
+```
 -->
 ### Expected Behavior
 

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,6 +1,9 @@
-<!-- Please tick when you have done these. They don't need to all be completed before the PR is created -->
-- [ ] If this is a bugfix, I have provided code that clearly demonstrates the problem and that works when used with this PR
-- [ ] I have added a test to the test suite, if necessary
-- [ ] I have properly documented new or changed features in the documention, or the docstrings
+<!--
+Please tick when you have done these. They don't need to all be completed before the PR is created.
+Delete them if they are not appropriate for this pull request.
+-->
+- [ ] <!--Only relevant if this is a bug fix-->I have provided code that clearly demonstrates the bug and only works correctly when used with this PR
+- [ ] I have added suitable tests to the test suite in `tests/`
+- [ ] I have properly documented new or changed features in the documention or in the docstrings
 - [ ] I have properly documented unusual changes to the code in the comments around it
 - [ ] I have made note of any breaking/backwards incompatible changes