From 11a005db964bcf4d82749b5c334dea9a8e394cad Mon Sep 17 00:00:00 2001 From: AngRodrigues Date: Tue, 28 May 2024 15:52:53 +1000 Subject: [PATCH 1/4] fix: remove value from issue templates --- .github/ISSUE_TEMPLATE/bug_report.yml | 4 ---- .github/ISSUE_TEMPLATE/feature_request.yml | 7 ------- 2 files changed, 11 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 8fe9facf..a5339db0 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -80,12 +80,8 @@ body: description: "Select the severity level of the bug." options: - label: "Low" - value: "low" - label: "Medium" - value: "medium" - label: "High" - value: "high" - label: "Critical" - value: "critical" validations: required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 00872c72..88886f89 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -62,16 +62,9 @@ body: description: "Select the areas of the project that this feature request impacts." options: - label: "input data" - value: "input data" - label: "project creation" - value: "project creation" - label: "samplers" - value: "samplers" - label: "sorters" - value: "sorters" - label: "stratigraphic column" - value: "stratigraphic column" - label: "data types" - value: "data types" - label: "Other" - value: "other" From ecb10926b25472672d7929d94aec0fec222ad09f Mon Sep 17 00:00:00 2001 From: AngRodrigues Date: Tue, 28 May 2024 16:11:33 +1000 Subject: [PATCH 2/4] fix: update wording in templates for clarity --- .github/ISSUE_TEMPLATE/documentation_request.yml | 4 ++-- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- .github/pull_request_template/bug_fix_template.md | 2 +- .github/pull_request_template/feature_template.md | 3 ++- .github/pull_request_template/tests_improvement_template.md | 4 ++-- 5 files changed, 8 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/documentation_request.yml b/.github/ISSUE_TEMPLATE/documentation_request.yml index 6fb074ad..ac5264cd 100644 --- a/.github/ISSUE_TEMPLATE/documentation_request.yml +++ b/.github/ISSUE_TEMPLATE/documentation_request.yml @@ -9,7 +9,7 @@ body: ## Documentation Request Please use this template to suggest an improvement or addition to map2loop documentation. - Provide as much detail as possible to help us understand and implement your request efficiently. + Provide as much detail as possible to help us understand and implement your request efficiently - type: input id: doc_title @@ -33,7 +33,7 @@ body: id: additional_context attributes: label: "Additional Context" - description: "Provide any other context or information that may be helpful." + description: "Any other context or information that may be helpful." placeholder: "Enter any additional context" validations: required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 88886f89..95f3ab79 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -41,7 +41,7 @@ body: id: proposed_solution attributes: label: "Proposed Solution" - description: "Describe how you envision the feature working. Include any specific requirements or details." + description: "Describe how you envision the feature working. Include any specific requirements or details" placeholder: "Explain how the feature should work" validations: required: true diff --git a/.github/pull_request_template/bug_fix_template.md b/.github/pull_request_template/bug_fix_template.md index afdc1497..6e1f53dd 100644 --- a/.github/pull_request_template/bug_fix_template.md +++ b/.github/pull_request_template/bug_fix_template.md @@ -21,4 +21,4 @@ Provide branch name so we can reproduce. - [ ] My code follows the style guidelines of this project - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation -- [ ] New and existing unit tests pass locally with my changes +- [ ] New and existing tests pass locally with my changes and pytest diff --git a/.github/pull_request_template/feature_template.md b/.github/pull_request_template/feature_template.md index 29a43a6e..76188bf1 100644 --- a/.github/pull_request_template/feature_template.md +++ b/.github/pull_request_template/feature_template.md @@ -24,4 +24,5 @@ Provide branch name so we can reproduce. - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing unit tests pass locally with my changes +- [ ] My tests run with pytest from the map2loop folder +- [ ] New and existing tests pass locally with my changes diff --git a/.github/pull_request_template/tests_improvement_template.md b/.github/pull_request_template/tests_improvement_template.md index 58fd8b08..5ffedf86 100644 --- a/.github/pull_request_template/tests_improvement_template.md +++ b/.github/pull_request_template/tests_improvement_template.md @@ -18,7 +18,7 @@ Provide branch name so we can reproduce. - [ ] This branch is up-to-date with master - [ ] All gh-action checks are passing - [ ] My tests run with pytest from the map2loop folder +- [ ] All tests pass locally with my changes - [ ] I have performed a self-review of my own tests -- [ ] My tests follow the style guidelines of this project - [ ] I have commented my tests, particularly in hard-to-understand areas -- [ ] New and existing unit tests pass locally with my changes + From dcbad8503174c9700651bb5c491323336d10c8b8 Mon Sep 17 00:00:00 2001 From: AngRodrigues Date: Tue, 28 May 2024 17:06:17 +1000 Subject: [PATCH 3/4] fix: merge PR templates into one single PR template --- .../pull_request_template.md} | 14 +++++++++-- .../pull_request_template/bug_fix_template.md | 24 ------------------- .../docs_update_template.md | 23 ------------------ .../tests_improvement_template.md | 24 ------------------- 4 files changed, 12 insertions(+), 73 deletions(-) rename .github/{pull_request_template/feature_template.md => ISSUE_TEMPLATE/pull_request_template.md} (57%) delete mode 100644 .github/pull_request_template/bug_fix_template.md delete mode 100644 .github/pull_request_template/docs_update_template.md delete mode 100644 .github/pull_request_template/tests_improvement_template.md diff --git a/.github/pull_request_template/feature_template.md b/.github/ISSUE_TEMPLATE/pull_request_template.md similarity index 57% rename from .github/pull_request_template/feature_template.md rename to .github/ISSUE_TEMPLATE/pull_request_template.md index 76188bf1..9fa0b194 100644 --- a/.github/pull_request_template/feature_template.md +++ b/.github/ISSUE_TEMPLATE/pull_request_template.md @@ -1,18 +1,23 @@ ## Description -Please include a summary of the changes and the related issue. Include relevant motivation and context, if appropriate. +📝 Thanks for contributing to map2loop! +Please describe the issue that this pull request addresses and summarize the changes you are implementing. +Include relevant motivation and context, if appropriate. List any new dependencies that are required for this change. Fixes #(issue) ## Type of change +- [ ] Documentation update +- [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Test improvement ## How Has This Been Tested? -Please describe the tests that you ran to verify your changes. +Please describe any tests that you ran to verify your changes. Provide branch name so we can reproduce. ## Checklist: @@ -26,3 +31,8 @@ Provide branch name so we can reproduce. - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] My tests run with pytest from the map2loop folder - [ ] New and existing tests pass locally with my changes + +## Checklist continued (if PR includes changes to documentation) +- [ ] I have built the documentation locally with make.bat +- [ ] I have built this documentation in docker, following the docker configuration in map2loop/docs +- [ ] I have checked my spelling and grammar \ No newline at end of file diff --git a/.github/pull_request_template/bug_fix_template.md b/.github/pull_request_template/bug_fix_template.md deleted file mode 100644 index 6e1f53dd..00000000 --- a/.github/pull_request_template/bug_fix_template.md +++ /dev/null @@ -1,24 +0,0 @@ -## Description - -Please describe the issue that this pull request addresses and summarize the changes you are implementing. - -Fixes #(issue) - -## Type of change - -- [ ] Bug fix (non-breaking change which fixes an issue) - -## How Has This Been Tested? - -Please describe any tests that you ran to verify your changes. -Provide branch name so we can reproduce. - -## Checklist: - -- [ ] This branch is up-to-date with master -- [ ] All gh-action checks are passing -- [ ] I have performed a self-review of my own code -- [ ] My code follows the style guidelines of this project -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] New and existing tests pass locally with my changes and pytest diff --git a/.github/pull_request_template/docs_update_template.md b/.github/pull_request_template/docs_update_template.md deleted file mode 100644 index 247529c3..00000000 --- a/.github/pull_request_template/docs_update_template.md +++ /dev/null @@ -1,23 +0,0 @@ -## Description - -Please include a summary of the changes. Include context if relevant. - -Fixes #(issue) - -## Type of change - -- [ ] Documentation update - -## How Has This Been Tested? -Please describe the tests that you ran to verify your changes. -Provide branch name so we can reproduce. - -## Checklist: - -- [ ] This branch is up-to-date with master -- [ ] All gh-action checks are passing -- [ ] I have performed a self-review of my own documentation -- [ ] I have built the documentation locally with make.bat -- [ ] I have built this documentation in docker, following the docker configuration in map2loop/docs -- [ ] My documentation follows the style guidelines of this project -- [ ] I have checked my spelling and grammar diff --git a/.github/pull_request_template/tests_improvement_template.md b/.github/pull_request_template/tests_improvement_template.md deleted file mode 100644 index 5ffedf86..00000000 --- a/.github/pull_request_template/tests_improvement_template.md +++ /dev/null @@ -1,24 +0,0 @@ -## Description - -Please include a summary of the added or modified test. List relevant functions tested. - -Fixes #(issue) - -## Type of change - -- [ ] Test improvement - -## How Has This Been Tested? - -Please describe the tests that you ran to verify your changes. -Provide branch name so we can reproduce. - -## Checklist: - -- [ ] This branch is up-to-date with master -- [ ] All gh-action checks are passing -- [ ] My tests run with pytest from the map2loop folder -- [ ] All tests pass locally with my changes -- [ ] I have performed a self-review of my own tests -- [ ] I have commented my tests, particularly in hard-to-understand areas - From 50751a940c78a981ec4c423e3c914615cede962f Mon Sep 17 00:00:00 2001 From: AngRodrigues Date: Tue, 28 May 2024 17:07:24 +1000 Subject: [PATCH 4/4] fix: keep things light --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .../ISSUE_TEMPLATE/documentation_request.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yml | 12 +++++++++++- .../ISSUE_TEMPLATE/pull_request_template.yml | 18 ------------------ .github/ISSUE_TEMPLATE/question.yml | 2 +- 5 files changed, 14 insertions(+), 22 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/pull_request_template.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index a5339db0..fa8ebe43 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,4 +1,4 @@ -name: "Bug Report" +name: "🐛 Bug Report" description: "Report a bug or an issue in map2loop" title: "[Bug] - " labels: ["bug"] diff --git a/.github/ISSUE_TEMPLATE/documentation_request.yml b/.github/ISSUE_TEMPLATE/documentation_request.yml index ac5264cd..22bce023 100644 --- a/.github/ISSUE_TEMPLATE/documentation_request.yml +++ b/.github/ISSUE_TEMPLATE/documentation_request.yml @@ -1,4 +1,4 @@ -name: "Documentation Request" +name: "📓 Documentation Request" description: "Help us improve map2loop documentation!" title: "[Documentation] - " labels: ["documentation"] diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 95f3ab79..de3a3215 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,4 +1,4 @@ -name: "Feature Request" +name: "🚀 Feature Request" description: "Suggest a new feature or enhancement for map2loop" title: "[Feature Request] - " labels: ["enhancement", "feature request"] @@ -10,6 +10,16 @@ body: Please use this template to submit your feature request. Provide as much detail as possible to help us understand and implement your request efficiently. + - type: checkboxes + id: input1 + attributes: + label: "💻" + description: | + Check this if you would like to try and implement your vision in a PR. + The map2loop team will help you go through the process + options: + - label: Would you like to work on this feature? + - type: input id: feature_title attributes: diff --git a/.github/ISSUE_TEMPLATE/pull_request_template.yml b/.github/ISSUE_TEMPLATE/pull_request_template.yml deleted file mode 100644 index 2fc5462a..00000000 --- a/.github/ISSUE_TEMPLATE/pull_request_template.yml +++ /dev/null @@ -1,18 +0,0 @@ -version: 2 - -pull_request_templates: - - name: Bug Fix Template - description: Use this template for bug fixes. - file: pull_request_template/bug_fix_template.md - - - name: Feature Template - description: Use this template for adding new features. - file: pull_request_template/feature_template.md - - - name: Documentation Update Template - description: Use this template for documentation updates. - file: pull_request_template/docs_update_template.md - - - name: Test Improvement Template - description: Use this template for adding a new test. - file: pull_request_template/tests_improvement_template.md \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index 65db9e62..6e43c3e1 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -1,4 +1,4 @@ -name: "Question" +name: "💬 Question" description: "Ask a question about map2loop!" title: "[Question] - " labels: ["question"]