Sfoglia il codice sorgente

HPCC-17012 Add github PULL_REQUEST_TEMPLATE.md file

Signed-off-by: Richard Chapman <rchapman@hpccsystems.com>
Richard Chapman 8 anni fa
parent
commit
3c8c96aa2e
1 ha cambiato i file con 57 aggiunte e 0 eliminazioni
  1. 57 0
      .github/PULL_REQUEST_TEMPLATE.md

+ 57 - 0
.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,57 @@
+<!-- Thank you for submitting a pull request to the HPCC project
+
+ PLEASE READ the following before proceeding.
+
+ Lines in comments may be deleted from the comment before you submit.
+ Other lines should be modified appropriately and left in place.
+
+ This project only accepts pull requests related to open JIRA issues.
+ If suggesting a new feature or change, please discuss it in a JIRA issue first.
+ If fixing a bug, there should be an issue describing it with steps to reproduce.
+ The title line of the pull request (and of each commit within it) should refer to the
+ associated issue using the format:
+
+ HPCC-nnnnn Short description of issue
+
+ This will allow the Jira ticket to be automatically updated to refer to this pull request,and
+ and will ensure that the automatically-generated changelog is properly formatted.
+ Where a pull request contains a single commit the pull request title will be set automatically,
+ assuming that the commit has followed the proper guidelines.
+
+ Please go over all the following points, and put an `x` in all the boxes that apply. You may find
+ it easier to press the 'Create' button first then click on the checkboxes to edit the comment.
+-->
+
+## Type of change:
+- [ ] This change is a bug fix (non-breaking change which fixes an issue).
+- [ ] This change is a new feature (non-breaking change which adds functionality).
+- [ ] This change is a breaking change (fix or feature that will cause existing behavior to change).
+
+## Checklist:
+- [ ] My code follows the code style of this project.
+  - [ ] My code does not create any new warnings from compiler, build system, or lint.
+- [ ] My change requires a change to the documentation.
+  - [ ] I have updated the documentation accordingly, or...
+  - [ ] I have created a JIRA ticket to update the documentation.
+  - [ ] Any new interfaces or exported functions are appropriately commented.
+- [ ] I have read the CONTRIBUTING document.
+- [ ] The change has been fully tested:
+  - [ ] I have added tests to cover my changes.
+  - [ ] All new and existing tests passed.
+  - [ ] I have checked that this change does not introduce memory leaks.
+  - [ ] I have used Valgrind or similar tools to check for potential issues.
+- [ ] I have given due consideration to all of the following potential concerns:
+  - [ ] Scalability
+  - [ ] Performance
+  - [ ] Security
+  - [ ] Premature optimization
+  - [ ] This change fixes the problem, not just the symptom
+  - [ ] The target branch of this pull request is appropriate for such a change.
+- [ ] There are no similar instances of the same problem that should be addressed
+  - [ ] I have addressed them here
+  - [ ] I have raised JIRA issues to address them separately
+
+## Testing:
+<!-- Please describe how this change has been tested.-->
+
+<!-- Thank you for taking the time to submit this pull request and to answer all of the above-->