github templates

Add templates for github, for templates to be used in new issues and new
PRs
This commit is contained in:
Ron Eldor 2017-06-21 14:57:25 +03:00 committed by Simon Butcher
parent 940737f43b
commit fe617367f8
2 changed files with 79 additions and 0 deletions

40
.github/issue_template.md vendored Normal file
View file

@ -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)**

39
.github/pull_request_template.md vendored Normal file
View file

@ -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.