Browse Source

add issue and PR templates

Steffen Jaeckel 8 years ago
parent
commit
44b15a76aa
2 changed files with 42 additions and 0 deletions
  1. 29 0
      .github/ISSUE_TEMPLATE.md
  2. 13 0
      .github/PULL_REQUEST_TEMPLATE.md

+ 29 - 0
.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,29 @@
+<!--
+
+Do you want to ask a question? Are you looking for support? The Mailing list is the best place for getting support: https://groups.google.com/forum/#!forum/libtom
+
+This is a very generic template, remove items that do not apply. For completed items, change [ ] to [x].
+
+-->
+
+### Prerequisites
+
+* [ ] Checked the developer manual
+* [ ] Checked that your issue isn't already filed: https://github.com/issues?utf8=✓&q=repo%3Alibtom%2Flibtomcrypt
+* [ ] Checked that your issue isn't related to TomsFastMath's limitation that PK operations can by default only be done with max. 2048bit keys
+
+### Description
+
+[Description of the issue]
+
+### Steps to Reproduce
+<!-- Please either describe your issue or even better, provide a functional code example reproducing your issue. -->
+
+### Version
+
+You can get this information from the define `SCRYPT` in `src/include/tomcrypt.h` or your local git repository by running `git describe --always --tags --dirty`. 
+Also, please include the compiler, the compiler version, the architecture and (if applicable) the MPI provider, the OS and what version of the OS you're experiencing the issue.
+
+### Additional Information
+
+Any additional information, configuration or data that might be necessary to reproduce the issue.

+ 13 - 0
.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+<!--
+
+Thank you for your pull request.
+
+If this fixes an existing github issue, make sure to have a line saying 'Fixes #XXXX' (without quotes) in the commit message.
+
+-->
+
+### Checklist
+<!-- Remove items that do not apply. For completed items, change [ ] to [x]. -->
+
+* [ ] documentation is added or updated
+* [ ] tests are added or updated