aboutsummaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorRon Eldor <ron.eldor@arm.com>2017-06-21 14:57:25 +0300
committerSimon Butcher <simon.butcher@arm.com>2017-07-27 21:44:34 +0100
commit4b53513db5d818532561546e7ba2d5b76b88cd93 (patch)
tree35d5130fc0e1ac037c4d35c1f11c368f161ea5e1 /.github
parent2c4d558873a3ae8d75868b70871331dfb9f92b3d (diff)
downloadmbedtls-4b53513db5d818532561546e7ba2d5b76b88cd93.zip
mbedtls-4b53513db5d818532561546e7ba2d5b76b88cd93.tar.gz
mbedtls-4b53513db5d818532561546e7ba2d5b76b88cd93.tar.bz2
github templates
Add templates for github, for templates to be used in new issues and new PRs
Diffstat (limited to '.github')
-rw-r--r--.github/issue_template.md40
-rw-r--r--.github/pull_request_template.md39
2 files changed, 79 insertions, 0 deletions
diff --git a/.github/issue_template.md b/.github/issue_template.md
new file mode 100644
index 0000000..3398f49
--- /dev/null
+++ b/.github/issue_template.md
@@ -0,0 +1,40 @@
+Note: This is just a template, so feel free to use/remove the unnecessary things
+
+### Description
+- Type: Bug | Enhancement\Feature Request | Question
+- Priority: Blocker | Major | Minor
+
+---------------------------------------------------------------
+## Bug
+
+**OS**
+linux|windows|??
+
+**mbed TLS build:**
+Version: x.x.x or git commit id
+Configuration: please attach config.h file
+Compiler and options (if you used a pre-built binary, please indicate how you obtained it):
+Additional environment information:
+
+**peer device TLS stack and version**
+openSSL | GnuTls | other
+version:
+
+**Expected behavior**
+
+**Actual behavior**
+
+**Steps to reproduce**
+
+----------------------------------------------------------------
+## Enhancement\Feature Request
+
+**Incentive for change**
+
+**Suggested enhancement**
+
+-----------------------------------------------------------------
+
+## Question
+
+**Please first check for answers in the [mbed TLS knowledge Base](https://tls.mbed.org/kb), and preferebly file an issue in the [mbed TLS support forum](https://tls.mbed.org/discussions)** \ No newline at end of file
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000..dac8bde
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,39 @@
+Notes:
+* Pull requests will not be accepted until:
+- The submitter has [accepted the online agreement here with a click through](https://developer.mbed.org/contributor_agreement/)
+ or those that do not wish to create an mbed account, a slightly different agreement can be found [here](https://www.mbed.com/en/about-mbed/contributor-license-agreements/)
+- The PR follows the [mbed TLS coding standards](https://tls.mbed.org/kb/development/mbedtls-coding-standards)
+* This is just a template, so feel free to use/remove the unnecessary things
+## Description
+A few sentences describing the overall goals of the pull request's commits.
+
+
+## Status
+**READY/IN DEVELOPMENT/HOLD**
+
+## Requires Backporting
+When there is a bug fix, it should be backported to legacy supported branches.
+legacy supported branches will not be backported if:
+- This PR is a new feature\enhancement
+- This PR contains changes in the API. If this is true, and there is a need for the fix to be backported, the fix should be handled differently in the legacy branch
+
+Yes | NO
+What branch?
+
+## Migrations
+If there is any API change, what's the incentive and logic for it.
+
+YES | NO
+
+## Additional comments
+Any additional information that could be of interest
+
+## Todos
+- [ ] Tests
+- [ ] Documentation
+- [ ] Changelog updated
+- [ ] Backported
+
+
+## Steps to test or reproduce
+Outline the steps to test or reproduce the PR here. \ No newline at end of file