From 34a12d8e0de4917f4dd9ad395ca320c00ba3c7a5 Mon Sep 17 00:00:00 2001 From: snowman2 Date: Wed, 8 Jan 2020 19:50:56 -0600 Subject: added issue & pull request templates --- .github/ISSUE_TEMPLATE/bug_report.md | 31 +++++++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 7 +++++++ .github/ISSUE_TEMPLATE/question.md | 9 +++++++++ .github/PULL_REQUEST_TEMPLATE.md | 5 +++++ 4 files changed, 52 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..805aac1e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,31 @@ +--- +name: Bug report +about: Create a report to help us improve +labels: bug +--- + + + + +#### Code Sample, a copy-pastable example if possible + +A "Minimal, Complete and Verifiable Example" will make it much easier for maintainers to help you: +http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports + +```c +# Your code here + +``` +#### Problem description + +[this should explain **why** the current behavior is a problem and why the expected output is a better solution.] + +#### Expected Output + + +#### Environment Information + - PROJ version (`proj`) + - Operation System Information (`python -c "import platform; print(platform.platform())"`) + +#### Installation method + - conda, apt-get, from source, etc... diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..097da51e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,7 @@ +--- +name: Feature request +about: Suggest an idea for this project +labels: proposal +--- + + \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 00000000..cee701d0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,9 @@ +--- +name: Question +about: Additional places to ask questions are on the PROJ mailing list (https://lists.osgeo.org/mailman/listinfo/proj) or GIS Stack Exchange (https://gis.stackexchange.com/questions/tagged/proj). +labels: question +--- + + \ 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 00000000..20efa59e --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,5 @@ + + + - [ ] Closes #xxxx + - [ ] Tests added + - [ ] Fully documented, including `NEWS`, `docs/source/news.rst` for all changes and `docs/source/*.rst` for new API \ No newline at end of file -- cgit v1.2.3 From 208117b0c72d92947218a6453485a517c086a927 Mon Sep 17 00:00:00 2001 From: "Alan D. Snow" Date: Fri, 10 Jan 2020 07:46:37 -0600 Subject: Update .github/ISSUE_TEMPLATE/feature_request.md Co-Authored-By: Kristian Evers --- .github/ISSUE_TEMPLATE/feature_request.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 097da51e..6f848455 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,7 +1,7 @@ --- name: Feature request about: Suggest an idea for this project -labels: proposal +labels: feature request --- - \ No newline at end of file + -- cgit v1.2.3 From c5254872497e9a6a8c0841c0b6d4931d534b5893 Mon Sep 17 00:00:00 2001 From: "Alan D. Snow" Date: Fri, 10 Jan 2020 07:46:43 -0600 Subject: Update .github/ISSUE_TEMPLATE/bug_report.md Co-Authored-By: Kristian Evers --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 805aac1e..0bd45203 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -8,7 +8,7 @@ labels: bug #### Code Sample, a copy-pastable example if possible - +Demonstrate the problem you have found, either by using PROJ tools like `cs2cs`, `cct` or `projinfo` **or** add a code snippet that highlights the problem using the PROJ C/C++ API. A "Minimal, Complete and Verifiable Example" will make it much easier for maintainers to help you: http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports -- cgit v1.2.3 From 595675b1e6f8789da025d82da0c7dfc79972fece Mon Sep 17 00:00:00 2001 From: "Alan D. Snow" Date: Fri, 10 Jan 2020 07:46:51 -0600 Subject: Update .github/ISSUE_TEMPLATE/bug_report.md Co-Authored-By: Kristian Evers --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 0bd45203..d1e01b5c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,7 +7,7 @@ labels: bug -#### Code Sample, a copy-pastable example if possible +#### Example of problem Demonstrate the problem you have found, either by using PROJ tools like `cs2cs`, `cct` or `projinfo` **or** add a code snippet that highlights the problem using the PROJ C/C++ API. A "Minimal, Complete and Verifiable Example" will make it much easier for maintainers to help you: http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports -- cgit v1.2.3 From ec14e9b3cb26017d5787dbdfa84202164af3551e Mon Sep 17 00:00:00 2001 From: "Alan D. Snow" Date: Fri, 10 Jan 2020 07:47:47 -0600 Subject: Update .github/ISSUE_TEMPLATE/bug_report.md Co-Authored-By: Kristian Evers --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d1e01b5c..dff2ab58 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -25,7 +25,7 @@ http://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports #### Environment Information - PROJ version (`proj`) - - Operation System Information (`python -c "import platform; print(platform.platform())"`) + - Operation System Information #### Installation method - conda, apt-get, from source, etc... -- cgit v1.2.3 From 948c0842a44d64b400d5ff3ea6b8d9c0fb2871ad Mon Sep 17 00:00:00 2001 From: snowman2 Date: Fri, 10 Jan 2020 07:48:57 -0600 Subject: removed question --- .github/ISSUE_TEMPLATE/question.md | 9 --------- 1 file changed, 9 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index cee701d0..00000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -name: Question -about: Additional places to ask questions are on the PROJ mailing list (https://lists.osgeo.org/mailman/listinfo/proj) or GIS Stack Exchange (https://gis.stackexchange.com/questions/tagged/proj). -labels: question ---- - - \ No newline at end of file -- cgit v1.2.3 From a4938a99199b03b41179b6fa666c3256b0e38a99 Mon Sep 17 00:00:00 2001 From: snowman2 Date: Fri, 10 Jan 2020 07:51:14 -0600 Subject: add notes about PR header title --- .github/PULL_REQUEST_TEMPLATE.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 20efa59e..25dc9b97 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,4 +2,5 @@ - [ ] Closes #xxxx - [ ] Tests added - - [ ] Fully documented, including `NEWS`, `docs/source/news.rst` for all changes and `docs/source/*.rst` for new API \ No newline at end of file + - [ ] Added clear title that can be used to generate release notes + - [ ] Fully documented, including updating `docs/source/*.rst` for new API \ No newline at end of file -- cgit v1.2.3