Merge pull request #5 from zomry1/Pull-Request-template

Pull request template

.github/pull_request_template.md

@@ -0,0 +1,39 @@
+# Description
+
+Please include a summary of the change and which issue is fixed. (Please mention the issue by typing # and issue number of title).  
+Please also include relevant motivation and context.
+
+## Type of change
+
+(Set X in the correct boxes)
+
+- [ ] Bug fix 
+- [ ] New feature
+- [ ] Coding style
+- [ ] Documentation update  
+
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+- [ ] This change changed the dependencies
+
+### List any dependencies that are required for this change.
+
+# How Has This Been Tested?
+
+Please describe the tests that you ran to verify your changes.  
+Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+
+
+**Test Configuration**:
+* Python version:
+* OS:
+
+# Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I rebase my code with the `dev` branch
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation - Optional
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works - Optional