From 691555aa22ddafd8b6940270829cea4cd2d86d79 Mon Sep 17 00:00:00 2001 From: Jussi Vatjus-Anttila Date: Tue, 9 Aug 2016 10:39:18 +0300 Subject: [PATCH 1/5] initial github issue and PR templates --- .github/issue_template.md | 48 ++++++++++++++++++++++++++++++++ .github/pull_request_template.md | 40 ++++++++++++++++++++++++++ 2 files changed, 88 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 00000000000..1bb189f846f --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,48 @@ +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 + +**target** +K64F|?? + +**toolchain:** +gcc|armcc|IAR + +**toolchain version:** + +**mbed-cli version:** +(`mbed --version`) + +**meed-os sha:** +(`git log -n1 --oneline`) + +**Daplink version:** + +**Expected Behavior** + +**Actual Behavior** + +**Steps to Reproduce** + +---------------------------------------------------------------- +## Enhancement + +**Reason to enhance/problem with existing solution** + +**Suggested enhancement** + +**Pros** + +**Cons** + +----------------------------------------------------------------- + +## Question + +**How to?** \ 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 00000000000..2124c7977ec --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,40 @@ +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 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: + +branch | PR +------ | ------ +other_pr_production | [link]() +other_pr_master | [link]() + + +## Todos +- [ ] Tests +- [ ] Documentation + + +## Deploy Notes +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. \ No newline at end of file From 217b0da0441874cda321c1775a9e45e5e71bf8b0 Mon Sep 17 00:00:00 2001 From: Jussi Vatjus-Anttila Date: Wed, 31 Aug 2016 15:08:51 +0300 Subject: [PATCH 2/5] small updates --- .github/issue_template.md | 2 +- .github/pull_request_template.md | 9 ++++----- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/.github/issue_template.md b/.github/issue_template.md index 1bb189f846f..1b98e788585 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -12,7 +12,7 @@ Note: This is just a template, so feel free to use/remove the unnecessary things K64F|?? **toolchain:** -gcc|armcc|IAR +GCC_ARM|ARM|IAR **toolchain version:** diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2124c7977ec..6666aa56d2d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,7 +1,10 @@ Notes: -* Pull requests will not be accepted until the submitter has agreed to the contributer agreement. +* Pull requests will not be accepted until the submitter has agreed to the [contributer agreement](https://github.com/ARMmbed/mbed-os/blob/master/CONTRIBUTING.md). * 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** @@ -13,10 +16,6 @@ If this PR changes any APIs or behaviors, give a short description of what "API YES | NO -## Description -A few sentences describing the overall goals of the pull request's commits. - - ## Related PRs List related PRs against other branches: From aa5990ec831c6c8dea07f17184d28e256e5716a4 Mon Sep 17 00:00:00 2001 From: Jussi Vatjus-Anttila Date: Fri, 2 Sep 2016 15:25:01 +0300 Subject: [PATCH 3/5] Update issue_template.md --- .github/issue_template.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/.github/issue_template.md b/.github/issue_template.md index 1b98e788585..32a3386b221 100644 --- a/.github/issue_template.md +++ b/.github/issue_template.md @@ -2,19 +2,19 @@ Note: This is just a template, so feel free to use/remove the unnecessary things ### Description - Type: Bug | Enhancement | Question -- Related Issue: `#abc` +- Related issue: `#abc` - Priority: Blocker | Major | Minor --------------------------------------------------------------- ## Bug -**target** +**Target** K64F|?? -**toolchain:** +**Toolchain:** GCC_ARM|ARM|IAR -**toolchain version:** +**Toolchain version:** **mbed-cli version:** (`mbed --version`) @@ -22,18 +22,18 @@ GCC_ARM|ARM|IAR **meed-os sha:** (`git log -n1 --oneline`) -**Daplink version:** +**DAPLink version:** -**Expected Behavior** +**Expected behavior** -**Actual Behavior** +**Actual behavior** -**Steps to Reproduce** +**Steps to reproduce** ---------------------------------------------------------------- ## Enhancement -**Reason to enhance/problem with existing solution** +**Reason to enhance or problem with existing solution** **Suggested enhancement** @@ -45,4 +45,4 @@ GCC_ARM|ARM|IAR ## Question -**How to?** \ No newline at end of file +**How to?** From 018f205a276bdd0159b3145481ecb2da1a13c103 Mon Sep 17 00:00:00 2001 From: Jussi Vatjus-Anttila Date: Fri, 2 Sep 2016 15:27:10 +0300 Subject: [PATCH 4/5] Update pull_request_template.md --- .github/pull_request_template.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6666aa56d2d..8f9b0559e9d 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -11,7 +11,7 @@ A few sentences describing the overall goals of the pull request's commits. ## Migrations -If this PR changes any APIs or behaviors, give a short description of what "API users" should do when this PR is merged. +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 @@ -30,10 +30,10 @@ other_pr_master | [link]() - [ ] Documentation -## Deploy Notes +## Deploy notes 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. \ No newline at end of file +## Steps to test or reproduce +Outline the steps to test or reproduce the PR here. From 709ef598754bd6239beed8a9d6fe06b8af95171b Mon Sep 17 00:00:00 2001 From: Jussi Vatjus-Anttila Date: Thu, 8 Sep 2016 12:05:47 +0300 Subject: [PATCH 5/5] Update pull_request_template.md --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 8f9b0559e9d..ca274f9b597 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -31,7 +31,7 @@ other_pr_master | [link]() ## Deploy notes -Notes regarding the deployment of the contained body of work. These should note any +Notes regarding the deployment of this PR. These should note any required changes in the build environment, tools, compilers, etc.