From 1a031588c468ea4bb1be56dfee1b65f92b8db060 Mon Sep 17 00:00:00 2001 From: Erjan Gavalji Date: Thu, 18 Feb 2016 10:32:57 +0200 Subject: [PATCH 1/6] Create the issue and PR templates under the .github folder --- CONTRIBUTING.md => .github/CONTRIBUTING.md | 0 .github/ISSUE_TEMPLATE.md | 20 ++++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 12 ++++++++++++ 3 files changed, 32 insertions(+) rename CONTRIBUTING.md => .github/CONTRIBUTING.md (100%) create mode 100644 .github/ISSUE_TEMPLATE.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md new file mode 100644 index 000000000..d47427835 --- /dev/null +++ b/.github/ISSUE_TEMPLATE.md @@ -0,0 +1,20 @@ +Welcome, dear friend! We, the rest of the NativeScript community really +appreciate your feedback! While we are doing all we can to take care of every +issue, sometimes we get overwhelmed. Because of that, we will consider issues +that are not constructive or report problems that cannot be reproduced "dead". +In accordance, we will treat feature requests or bug reports with unanswered +questions regarding the behavior/reproduction "dead". All "dead" issues will +get closed. + +## Please, help the others with the details below: + +### Did you verify this is a real problem with a search in [StackOverflow](http://stackoverflow.com/questions/tagged/nativescript)? + +### Tell us about the problem + +### Which version of NativeScript did you use (check the 'version' atrribute in the node_modules/tns-core-modules/package.json file) + +### Try to recall what were you doing + +### Is there code involved? Can you share the minimum of it to get the problem? + diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 000000000..2fb3cfe4f --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,12 @@ +Dear friend, we, the rest of the NativeScript community thank you for your +contribution! As we want to present a really nice, readable changelog with each +release, we ask you to fill the following information: + +### Inform what relation and with with issue does it have (in other words, delete the unnecessary): +Fixes/Implements #[Issue Number]. + +### Does it have [unit tests](https://github.com/NativeScript/NativeScript/blob/master/running-tests.md)? +If not, why? +If not, can you list any steps to test it manually? + + From cee53da55e33c28b9aa7755824c9a6915e24ba2b Mon Sep 17 00:00:00 2001 From: Erjan Gavalji Date: Thu, 18 Feb 2016 18:10:08 +0200 Subject: [PATCH 2/6] Add a reference to the commit message article --- .github/ISSUE_TEMPLATE.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index d47427835..c78e7152e 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -11,6 +11,10 @@ get closed. ### Did you verify this is a real problem with a search in [StackOverflow](http://stackoverflow.com/questions/tagged/nativescript)? ### Tell us about the problem +Please, ensure your title is less than 50 characters and starts with a capital +letter. We strive to follow the guidelines in the +[How to Write a Git Commit Message] (http://chris.beams.io/posts/git-commit/) +article for PR titles. ### Which version of NativeScript did you use (check the 'version' atrribute in the node_modules/tns-core-modules/package.json file) From 940fe3bb3d0185c1a85cc23382f4322289c411a7 Mon Sep 17 00:00:00 2001 From: Erjan Gavalji Date: Thu, 18 Feb 2016 18:20:22 +0200 Subject: [PATCH 3/6] Add a period notice for dead issues --- .github/ISSUE_TEMPLATE.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index c78e7152e..20d770afb 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -3,8 +3,8 @@ appreciate your feedback! While we are doing all we can to take care of every issue, sometimes we get overwhelmed. Because of that, we will consider issues that are not constructive or report problems that cannot be reproduced "dead". In accordance, we will treat feature requests or bug reports with unanswered -questions regarding the behavior/reproduction "dead". All "dead" issues will -get closed. +questions regarding the behavior/reproduction for more than 20 days "dead". All +"dead" issues will get closed. ## Please, help the others with the details below: From 4b9bb6693eb703353462853c09843a3835a0380f Mon Sep 17 00:00:00 2001 From: Erjan Gavalji Date: Fri, 19 Feb 2016 11:12:33 +0200 Subject: [PATCH 4/6] Improve questions according to github comments Improve questions according to the comments in the [pull request](https://github.com/NativeScript/NativeScript/pull/1582): Cleaner definition of versions Typo fix Platform specification More precise definition of search places --- .github/ISSUE_TEMPLATE.md | 15 ++++++++++++--- .github/PULL_REQUEST_TEMPLATE.md | 2 +- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 20d770afb..6b61a5844 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,4 +1,4 @@ -Welcome, dear friend! We, the rest of the NativeScript community really +Welcome dear friend! We, the rest of the NativeScript community really appreciate your feedback! While we are doing all we can to take care of every issue, sometimes we get overwhelmed. Because of that, we will consider issues that are not constructive or report problems that cannot be reproduced "dead". @@ -8,7 +8,9 @@ questions regarding the behavior/reproduction for more than 20 days "dead". All ## Please, help the others with the details below: -### Did you verify this is a real problem with a search in [StackOverflow](http://stackoverflow.com/questions/tagged/nativescript)? +### Did you verify this is a real problem with a search in +[StackOverflow](http://stackoverflow.com/questions/tagged/nativescript) +and the other issues here? ### Tell us about the problem Please, ensure your title is less than 50 characters and starts with a capital @@ -16,7 +18,14 @@ letter. We strive to follow the guidelines in the [How to Write a Git Commit Message] (http://chris.beams.io/posts/git-commit/) article for PR titles. -### Which version of NativeScript did you use (check the 'version' atrribute in the node_modules/tns-core-modules/package.json file) +### Which platform does it happen on? +iOS/Android/Both + +### Which versions of the NativeScript elements did you use? +CLI: (run tns --version to fetch it) +Cross-platform modules: (check the 'version' attribute in the +`node_modules/tns-core-modules/package.json` file in your project) +Runtime: (check the entries in the package.json file of your project) ### Try to recall what were you doing diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 2fb3cfe4f..506cd24da 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,7 +2,7 @@ Dear friend, we, the rest of the NativeScript community thank you for your contribution! As we want to present a really nice, readable changelog with each release, we ask you to fill the following information: -### Inform what relation and with with issue does it have (in other words, delete the unnecessary): +### Inform what relation and with which issue does it have (in other words, delete the unnecessary): Fixes/Implements #[Issue Number]. ### Does it have [unit tests](https://github.com/NativeScript/NativeScript/blob/master/running-tests.md)? From d99e7336df418990f46d3d4a8b4bb140634e09a1 Mon Sep 17 00:00:00 2001 From: Erjan Gavalji Date: Thu, 25 Feb 2016 07:29:36 +0200 Subject: [PATCH 5/6] Address the comments in the PR Improve wording Add code-blocks to improve readability --- .github/ISSUE_TEMPLATE.md | 31 ++++++++++++++----------------- .github/PULL_REQUEST_TEMPLATE.md | 16 +++++++++++----- 2 files changed, 25 insertions(+), 22 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 6b61a5844..4c367d1e8 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,33 +1,30 @@ -Welcome dear friend! We, the rest of the NativeScript community really +Dear friend, we, the rest of the NativeScript community really appreciate your feedback! While we are doing all we can to take care of every issue, sometimes we get overwhelmed. Because of that, we will consider issues -that are not constructive or report problems that cannot be reproduced "dead". -In accordance, we will treat feature requests or bug reports with unanswered +that are not constructive or problems that cannot be reproduced "dead". +Additionally, we will treat feature requests or bug reports with unanswered questions regarding the behavior/reproduction for more than 20 days "dead". All "dead" issues will get closed. -## Please, help the others with the details below: +## Please, provide the details below: -### Did you verify this is a real problem with a search in -[StackOverflow](http://stackoverflow.com/questions/tagged/nativescript) -and the other issues here? +### Did you verify this is a real problem by searching [Stack Overflow](http://stackoverflow.com/questions/tagged/nativescript) and the [other open issues in this repo](https://github.com/NativeScript/nativescript/issues)? ### Tell us about the problem -Please, ensure your title is less than 50 characters and starts with a capital -letter. We strive to follow the guidelines in the -[How to Write a Git Commit Message] (http://chris.beams.io/posts/git-commit/) -article for PR titles. +Please, ensure your title is less than 63 characters long and starts with a capital +letter. -### Which platform does it happen on? +### Which platform(s) does your issue occur on? iOS/Android/Both -### Which versions of the NativeScript elements did you use? -CLI: (run tns --version to fetch it) +### Please provide the following version numbers that your issue occurs with: +CLI: (run `tns --version` to fetch it) Cross-platform modules: (check the 'version' attribute in the `node_modules/tns-core-modules/package.json` file in your project) -Runtime: (check the entries in the package.json file of your project) +Runtime(s): (look for the `"tns-android"` and `"tns-ios"` properties in your +project’s `package.json` file) -### Try to recall what were you doing +### Please tell us how to recreate the issue in as much detail as possible. -### Is there code involved? Can you share the minimum of it to get the problem? +### Is there code involved? If so, please share the minimal amount of code needed to recreate the problem. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 506cd24da..485cbce02 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,12 +1,18 @@ Dear friend, we, the rest of the NativeScript community thank you for your -contribution! As we want to present a really nice, readable changelog with each -release, we ask you to fill the following information: +contribution! Because we want to present a really nice, readable changelog with each +release, please provide the following information: -### Inform what relation and with which issue does it have (in other words, delete the unnecessary): +### Create a meaningful title +Please, ensure your title is less than 50 characters and starts with a capital +letter. We strive to follow the guidelines in the +[How to Write a Git Commit Message] (http://chris.beams.io/posts/git-commit/) +article for PR titles. + +### Does your commit message include the wording below to reference a specific issue in this repo? Fixes/Implements #[Issue Number]. -### Does it have [unit tests](https://github.com/NativeScript/NativeScript/blob/master/running-tests.md)? +### Does your pull request have [unit tests](https://github.com/NativeScript/NativeScript/blob/master/running-tests.md)? If not, why? -If not, can you list any steps to test it manually? +If not, please tell us why tests are not included, and list all steps needed to test your pull request manually. From 13dbe4fd8023c8262e8f30fb8626dcb1cbf87cf8 Mon Sep 17 00:00:00 2001 From: Erjan Gavalji Date: Thu, 25 Feb 2016 07:33:07 +0200 Subject: [PATCH 6/6] Add a plugin version note --- .github/ISSUE_TEMPLATE.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 4c367d1e8..d2646436a 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -18,11 +18,13 @@ letter. iOS/Android/Both ### Please provide the following version numbers that your issue occurs with: -CLI: (run `tns --version` to fetch it) -Cross-platform modules: (check the 'version' attribute in the +- CLI: (run `tns --version` to fetch it) +- Cross-platform modules: (check the 'version' attribute in the `node_modules/tns-core-modules/package.json` file in your project) -Runtime(s): (look for the `"tns-android"` and `"tns-ios"` properties in your -project’s `package.json` file) +- Runtime(s): (look for the `"tns-android"` and `"tns-ios"` properties in the +`package.json` file of your project) +- Plugin(s): (look for the version number in the `package.json` file of your +project) ### Please tell us how to recreate the issue in as much detail as possible.