From 7afa17a2a4d5c6b2d94ace77db9fca5f5a00861f Mon Sep 17 00:00:00 2001 From: Jussi Vatjus-Anttila Date: Thu, 9 Jun 2016 13:50:47 +0100 Subject: [PATCH 1/3] initial issue and PR github templates --- .github/issue_template.md | 38 ++++++++++++++++++++++++++++++++ .github/pull_request_template.md | 29 ++++++++++++++++++++++++ 2 files changed, 67 insertions(+) create mode 100644 .github/issue_template.md create mode 100644 .github/pull_request_template.md diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100644 index 0000000000..ddf3bb511a --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,38 @@ +Note: This is just a template, so feel free to use/remove the unnecessary things + +### Description +- Type: Bug | Enhancement | Question +- Related Issue: `#abc` +- Priority: Blocker | Major | Minor + +--------------------------------------------------------------- +## Bug + +**mbed-os sha** +(`git describe --tags`) + +**mbed-cli version** +(`mbed`) + +**Expected Behavior** + +**Actual Behavior** + +**Steps to Reproduce** + +---------------------------------------------------------------- +## Enhancement + +**Reason to enhance/problem with existing solution** + +**Suggested enhancement** + +**Pros** + +**Cons** + +----------------------------------------------------------------- + +## Question + +**How to?** diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000000..4f75f1beaf --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,29 @@ +## Status +**READY/IN DEVELOPMENT/HOLD** + +## Migrations +YES | NO + +## Description +A few sentences describing the overall goals of the pull request's commits. + +## Related PRs +List related PRs against other branches: + +branch | PR +------ | ------ +other_pr_production | [link]() +other_pr_master | [link]() + + +## Todos +- [ ] Tests +- [ ] Documentation + + +## Deploy Notes +Notes regarding deployment the contained body of work. These should note any +db migrations, etc. + +## Steps to Test or Reproduce +Outline the steps to test or reproduce the PR here. From f80a843502e1db51e8e4255694aec47f4632f8af Mon Sep 17 00:00:00 2001 From: Jussi Vatjus-Anttila Date: Thu, 9 Jun 2016 21:31:25 +0100 Subject: [PATCH 2/3] Update pull_request_template.md updated against proposals --- .github/pull_request_template.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 4f75f1beaf..c2786d5104 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,9 +1,13 @@ +Note: This is just a template, so feel free to use/remove the unnecessary things + ## Status **READY/IN DEVELOPMENT/HOLD** ## Migrations +If this PR change any API's or it's behavior give short description what "API users" should do when this PR is in use. YES | NO + ## Description A few sentences describing the overall goals of the pull request's commits. @@ -22,8 +26,9 @@ other_pr_master | [link]() ## Deploy Notes -Notes regarding deployment the contained body of work. These should note any -db migrations, etc. +Notes regarding the deployment of the contained body of work. These should note any +required changes in the build environment, tools, compilers, etc. + ## Steps to Test or Reproduce Outline the steps to test or reproduce the PR here. From 3e3c10f1ea2e617ae25bffa38a8696a768329dbc Mon Sep 17 00:00:00 2001 From: Jussi Vatjus-Anttila Date: Fri, 10 Jun 2016 10:11:01 +0100 Subject: [PATCH 3/3] Update pull_request_template.md --- .github/pull_request_template.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index c2786d5104..1e7c2a522d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,16 +1,22 @@ -Note: This is just a template, so feel free to use/remove the unnecessary things +Notes: +* Pull requests will not be accepted until the submitter has agreed to the contributer agreement. +* This is just a template, so feel free to use/remove the unnecessary things + ## Status **READY/IN DEVELOPMENT/HOLD** + ## Migrations -If this PR change any API's or it's behavior give short description what "API users" should do when this PR is in use. +If this PR changes any APIs or behaviors, give a short description of what "API users" should do when this PR is merged. + YES | NO ## Description A few sentences describing the overall goals of the pull request's commits. + ## Related PRs List related PRs against other branches: