From e1ef2a013189a3933d4e3126f54d801921a9b8a1 Mon Sep 17 00:00:00 2001 From: AngRodrigues Date: Mon, 27 May 2024 12:46:12 +1000 Subject: [PATCH 01/18] Revert "Update issue templates" --- .github/ISSUE_TEMPLATE/bug_report.yml | 91 ------------------- .../ISSUE_TEMPLATE/documentation_request.yml | 39 -------- .github/ISSUE_TEMPLATE/feature_request.yml | 77 ---------------- .../ISSUE_TEMPLATE/pull_request_template.yml | 18 ---- .github/ISSUE_TEMPLATE/question.yml | 48 ---------- .../pull_request_template/bug_fix_template.md | 24 ----- .../docs_update_template.md | 23 ----- .../pull_request_template/feature_template.md | 27 ------ .../tests_improvement_template.md | 24 ----- 9 files changed, 371 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/documentation_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/pull_request_template.yml delete mode 100644 .github/ISSUE_TEMPLATE/question.yml 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/feature_template.md delete mode 100644 .github/pull_request_template/tests_improvement_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index 8fe9facf..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,91 +0,0 @@ -name: "Bug Report" -description: "Report a bug or an issue in map2loop" -title: "[Bug] - " -labels: ["bug"] -body: - - type: markdown - attributes: - value: | - ## Bug Report - Thanks for submitting a bug report to map2loop! - Please use this template to report a bug. Please provide as much detail as possible to help us reproduce and fix the issue efficiently. - - - type: input - id: bug_title - attributes: - label: "Bug Title" - description: "Provide a concise and descriptive title for the bug report." - placeholder: "Enter the title of the bug" - validations: - required: true - - - type: textarea - id: bug_description - attributes: - label: "Bug Description" - description: "Describe the bug you encountered. Include details on what you expected to happen and what actually happened." - placeholder: "Enter a detailed description of the bug" - validations: - required: true - - - type: textarea - id: steps_to_reproduce - attributes: - label: "Minimal reproducible example" - description: "Provide a minimal reproducible example with the code and data necessary to reproduce the bug." - placeholder: "Enter the steps to reproduce the bug" - validations: - required: true - - - type: textarea - id: expected_behavior - attributes: - label: "Expected Behavior" - description: "Describe what you expected to happen." - placeholder: "Enter the expected behavior" - validations: - required: true - - - type: textarea - id: actual_behavior - attributes: - label: "Actual Behavior" - description: "Describe what actually happened when you encountered the bug." - placeholder: "Enter the actual behavior" - validations: - required: true - - - type: textarea - id: additional_context - attributes: - label: "Additional Context" - description: "Provide any other context or information that may be helpful in understanding and fixing the bug." - placeholder: "Enter any additional context" - validations: - required: false - - - type: input - id: environment - attributes: - label: "Environment" - description: "Specify the environment in which the bug occurred (e.g., operating system, browser, application version)." - placeholder: "Enter the environment details" - validations: - required: true - - - type: checkboxes - id: severity - attributes: - label: "Severity" - 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/documentation_request.yml b/.github/ISSUE_TEMPLATE/documentation_request.yml deleted file mode 100644 index 6fb074ad..00000000 --- a/.github/ISSUE_TEMPLATE/documentation_request.yml +++ /dev/null @@ -1,39 +0,0 @@ -name: "Documentation Request" -description: "Help us improve map2loop documentation!" -title: "[Documentation] - " -labels: ["documentation"] -body: - - type: markdown - attributes: - value: | - ## 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. - - - type: input - id: doc_title - attributes: - label: "Documentation Title" - description: "Provide a concise and descriptive title for the documentation request." - placeholder: "Enter the title of the documentation request" - validations: - required: true - - - type: textarea - id: doc_details - attributes: - label: "Documentation Details" - description: "Describe the documentation you would like to see. Include details on why it is needed and how it should be structured." - placeholder: "Enter a detailed description of the documentation" - validations: - required: true - - - type: textarea - id: additional_context - attributes: - label: "Additional Context" - description: "Provide 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 deleted file mode 100644 index 00872c72..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ /dev/null @@ -1,77 +0,0 @@ -name: "Feature Request" -description: "Suggest a new feature or enhancement for map2loop" -title: "[Feature Request] - " -labels: ["enhancement", "feature request"] -body: - - type: markdown - attributes: - value: | - ## Feature Request - - 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: input - id: feature_title - attributes: - label: "Feature Title" - description: "Provide a concise and descriptive title for the feature request." - placeholder: "Enter the title of the feature" - validations: - required: true - - - type: textarea - id: feature_description - attributes: - label: "Feature Description" - description: "Describe the feature you would like to see. Include details on why it is needed and how it should work." - placeholder: "Enter a detailed description of the feature" - validations: - required: true - - - type: textarea - id: current_situation - attributes: - label: "Current Situation" - description: "Describe the current situation and how the absence of this feature affects you." - placeholder: "Explain the current situation and its drawbacks" - validations: - required: true - - - type: textarea - id: proposed_solution - attributes: - label: "Proposed Solution" - description: "Describe how you envision the feature working. Include any specific requirements or details." - placeholder: "Explain how the feature should work" - validations: - required: true - - - type: input - id: additional_context - attributes: - label: "Additional Context" - description: "Provide any other context or information that may be helpful in understanding the feature request." - placeholder: "Enter any additional context" - validations: - required: false - - - type: checkboxes - id: affected_areas - attributes: - label: "Affected Areas" - 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" 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 deleted file mode 100644 index 65db9e62..00000000 --- a/.github/ISSUE_TEMPLATE/question.yml +++ /dev/null @@ -1,48 +0,0 @@ -name: "Question" -description: "Ask a question about map2loop!" -title: "[Question] - " -labels: ["question"] -body: - - type: markdown - attributes: - value: | - ## Question - - Please use this template to ask a question about applying map2loop to your data. - Provide as much detail as possible to help us understand and answer your question efficiently. - - - type: input - id: question_title - attributes: - label: "Question Title" - description: "Provide a concise and descriptive title for your question." - placeholder: "Enter the title of your question" - validations: - required: true - - - type: textarea - id: question_details - attributes: - label: "Question Details" - description: "Describe your question in detail. Include any context or background information that might be helpful." - placeholder: "Enter the details of your question" - validations: - required: true - - - type: textarea - id: relevant_code_snippets - attributes: - label: "Relevant code or data" - description: "If applicable, provide any relevant code snippets or examples related to your question." - placeholder: "Enter any relevant code snippets" - validations: - required: false - - - type: input - id: additional_context - attributes: - label: "Additional Context" - description: "Provide any other context or information that may be helpful in answering your question." - placeholder: "Enter any additional context" - validations: - required: false 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 afdc1497..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 unit tests pass locally with my changes 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/feature_template.md b/.github/pull_request_template/feature_template.md deleted file mode 100644 index 29a43a6e..00000000 --- a/.github/pull_request_template/feature_template.md +++ /dev/null @@ -1,27 +0,0 @@ -## Description - -Please include a summary of the changes and the related issue. Include relevant motivation and context, if appropriate. -List any new dependencies that are required for this change. - -Fixes #(issue) - -## Type of change - -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - -## 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 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 -- [ ] 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 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 58fd8b08..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 -- [ ] 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 08ce648d5adcbfa15b17000303f277cccdf4534b Mon Sep 17 00:00:00 2001 From: Lachlan Grose Date: Thu, 9 May 2024 15:02:17 +1000 Subject: [PATCH 02/18] fix: trigger build --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index f654acc5..9a85e71f 100644 --- a/setup.py +++ b/setup.py @@ -57,4 +57,4 @@ def get_description(): "Topic :: Scientific/Engineering :: GIS", ], python_requires=">=3.8", -) +) From 3f1b453cc620f26d395ad478f3ebbb035329dd1f Mon Sep 17 00:00:00 2001 From: lachlangrose Date: Thu, 9 May 2024 05:02:37 +0000 Subject: [PATCH 03/18] style: style fixes by ruff and autoformatting by black --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 9a85e71f..f654acc5 100644 --- a/setup.py +++ b/setup.py @@ -57,4 +57,4 @@ def get_description(): "Topic :: Scientific/Engineering :: GIS", ], python_requires=">=3.8", -) +) From 33c663d4c4a75757ddc243ea6d1b4a4b0b696549 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 9 May 2024 05:10:10 +0000 Subject: [PATCH 04/18] chore(master): release 3.1.1 --- CHANGELOG.md | 7 +++++++ map2loop/version.py | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ca4c5763..9df75906 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +## [3.1.1](https://github.com/Loop3D/map2loop/compare/v3.1.0...v3.1.1) (2024-05-09) + + +### Bug Fixes + +* trigger build ([f1879ce](https://github.com/Loop3D/map2loop/commit/f1879ced58154610ccadd46488cdf7f109ca1810)) + ## 3.1.0 (2024-05-09) diff --git a/map2loop/version.py b/map2loop/version.py index f5f41e56..d539d50c 100644 --- a/map2loop/version.py +++ b/map2loop/version.py @@ -1 +1 @@ -__version__ = "3.1.0" +__version__ = "3.1.1" From 111af95b327c69a4b8e7b4d5bf8d74dc61524c76 Mon Sep 17 00:00:00 2001 From: AngRodrigues Date: Thu, 9 May 2024 16:18:47 +1000 Subject: [PATCH 05/18] fix: update doc deploy --- .github/workflows/CD.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/CD.yml b/.github/workflows/CD.yml index 79612ece..c8ecc1fd 100644 --- a/.github/workflows/CD.yml +++ b/.github/workflows/CD.yml @@ -147,7 +147,7 @@ jobs: run: | ls -l docs - name: Deploy 🚀 - uses: JamesIves/github-pages-deploy-action@4 + uses: JamesIves/github-pages-deploy-action@v4 with: branch: gh-pages # The branch the action should deploy to. folder: docs # The folder the action should deploy. \ No newline at end of file From 43d2b3d37d6bcf6c2bfaee607260ffc2f3c9bfdb Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 9 May 2024 06:37:44 +0000 Subject: [PATCH 06/18] chore(master): release 3.1.2 --- CHANGELOG.md | 7 +++++++ map2loop/version.py | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 9df75906..12ac2de7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # Changelog +## [3.1.2](https://github.com/Loop3D/map2loop/compare/v3.1.1...v3.1.2) (2024-05-09) + + +### Bug Fixes + +* update doc deploy ([cf0de5b](https://github.com/Loop3D/map2loop/commit/cf0de5b937c251ac71522488392f7ba7d65d78c6)) + ## [3.1.1](https://github.com/Loop3D/map2loop/compare/v3.1.0...v3.1.1) (2024-05-09) diff --git a/map2loop/version.py b/map2loop/version.py index d539d50c..911557b8 100644 --- a/map2loop/version.py +++ b/map2loop/version.py @@ -1 +1 @@ -__version__ = "3.1.1" +__version__ = "3.1.2" From 60b551e637d2fe1b898305a186b0afd613896f08 Mon Sep 17 00:00:00 2001 From: AngRodrigues Date: Tue, 14 May 2024 11:09:01 +1000 Subject: [PATCH 07/18] docs: remove lavavu; no need for 3D vis for the examples --- docs/Dockerfile | 5 +---- docs/source/conf.py | 24 +++++++++++------------- 2 files changed, 12 insertions(+), 17 deletions(-) diff --git a/docs/Dockerfile b/docs/Dockerfile index 0fb83117..c3165b30 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -27,12 +27,9 @@ RUN conda install -c conda-forge --file ./docs/requirements.txt -y RUN pip install . -# RUN pip install lavavu-osmesa==1.8.45 -ENV LD_LIBRARY_PATH=/opt/conda/lib/python3.10/site-packages/lavavu_osmesa.libs - ENV TINI_VERSION v0.19.0 ADD https://github.com/krallin/tini/releases/download/${TINI_VERSION}/tini /tini RUN chmod +x /tini -# ENTRYPOINT ["/tini", "--"] +ENTRYPOINT ["/tini", "--"] WORKDIR / \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index afc40e0d..ce0bf2d7 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -105,19 +105,17 @@ # Sphinx gallery examples -try: - from LoopStructural.visualisation.sphinx_scraper import Scraper as LoopScraper - from sphinx_gallery.sorting import ExampleTitleSortKey - - sphinx_gallery_conf = { - "examples_dirs": ["../examples/"], - "gallery_dirs": ["_auto_examples/"], # path to where to save gallery generated output - "image_scrapers": ("matplotlib", LoopScraper()), - "within_subsection_order": ExampleTitleSortKey, - "reference_url": {"LoopStructural": None}, - } -except ImportError: - pass + +# from LoopStructural.visualisation.sphinx_scraper import Scraper as LoopScraper +from sphinx_gallery.sorting import ExampleTitleSortKey + +sphinx_gallery_conf = { + "examples_dirs": ["../examples/"], + "gallery_dirs": ["_auto_examples/"], # path to where to save gallery generated output + "image_scrapers": ("matplotlib"), + "within_subsection_order": ExampleTitleSortKey, + "reference_url": {"LoopStructural": None}, +} # def setup(app): # app.add_stylesheet('custom.css') From ef446ce86524d633c321e1463204bfc6d29a0f03 Mon Sep 17 00:00:00 2001 From: AngRodrigues Date: Tue, 14 May 2024 01:09:23 +0000 Subject: [PATCH 08/18] style: style fixes by ruff and autoformatting by black --- docs/source/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index ce0bf2d7..e5edd5e6 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -105,7 +105,6 @@ # Sphinx gallery examples - # from LoopStructural.visualisation.sphinx_scraper import Scraper as LoopScraper from sphinx_gallery.sorting import ExampleTitleSortKey From 1809857bfd3e1eae760f91e50dc185e23be7816d Mon Sep 17 00:00:00 2001 From: AngRodrigues Date: Tue, 14 May 2024 13:14:39 +1000 Subject: [PATCH 09/18] fix: remove tini from docker --- docs/Dockerfile | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/Dockerfile b/docs/Dockerfile index c3165b30..86879a31 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -27,9 +27,4 @@ RUN conda install -c conda-forge --file ./docs/requirements.txt -y RUN pip install . -ENV TINI_VERSION v0.19.0 -ADD https://github.com/krallin/tini/releases/download/${TINI_VERSION}/tini /tini -RUN chmod +x /tini -ENTRYPOINT ["/tini", "--"] - WORKDIR / \ No newline at end of file From a5312bcaabbbf6703be81de0d28ffe68528e78e1 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 14 May 2024 04:48:56 +0000 Subject: [PATCH 10/18] chore(master): release 3.1.3 --- CHANGELOG.md | 12 ++++++++++++ map2loop/version.py | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 12ac2de7..edd4dba1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ # Changelog +## [3.1.3](https://github.com/Loop3D/map2loop/compare/v3.1.2...v3.1.3) (2024-05-14) + + +### Bug Fixes + +* remove tini from docker ([89fd60f](https://github.com/Loop3D/map2loop/commit/89fd60f35445f96894c153d3f8c5f6451bcbf0ed)) + + +### Documentation + +* remove lavavu; no need for 3D vis for the examples ([e8b1ada](https://github.com/Loop3D/map2loop/commit/e8b1ada0345cfebef114be555e770fd594155b16)) + ## [3.1.2](https://github.com/Loop3D/map2loop/compare/v3.1.1...v3.1.2) (2024-05-09) diff --git a/map2loop/version.py b/map2loop/version.py index 911557b8..f7493720 100644 --- a/map2loop/version.py +++ b/map2loop/version.py @@ -1 +1 @@ -__version__ = "3.1.2" +__version__ = "3.1.3" From b7385d2d8e62363e50e4e07e7d048ed1af0f4cc8 Mon Sep 17 00:00:00 2001 From: Lachlan Grose Date: Mon, 20 May 2024 12:08:46 +1000 Subject: [PATCH 11/18] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..dd84ea78 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..bbcbbe7d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. From e956c928b72a765f8cb190800d0ec627bdbeda9c Mon Sep 17 00:00:00 2001 From: AngRodrigues Date: Wed, 22 May 2024 15:28:01 +1000 Subject: [PATCH 12/18] feat: added issue_templates edit dddf70b chore: added issue_templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 -------- .github/ISSUE_TEMPLATE/bug_report.yml | 91 +++++++++++++++++++ .../ISSUE_TEMPLATE/documentation_request.yml | 39 ++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ---- .github/ISSUE_TEMPLATE/feature_request.yml | 77 ++++++++++++++++ .github/ISSUE_TEMPLATE/question.yml | 48 ++++++++++ 6 files changed, 255 insertions(+), 58 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index dd84ea78..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: '' -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..8fe9facf --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,91 @@ +name: "Bug Report" +description: "Report a bug or an issue in map2loop" +title: "[Bug] - " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + ## Bug Report + Thanks for submitting a bug report to map2loop! + Please use this template to report a bug. Please provide as much detail as possible to help us reproduce and fix the issue efficiently. + + - type: input + id: bug_title + attributes: + label: "Bug Title" + description: "Provide a concise and descriptive title for the bug report." + placeholder: "Enter the title of the bug" + validations: + required: true + + - type: textarea + id: bug_description + attributes: + label: "Bug Description" + description: "Describe the bug you encountered. Include details on what you expected to happen and what actually happened." + placeholder: "Enter a detailed description of the bug" + validations: + required: true + + - type: textarea + id: steps_to_reproduce + attributes: + label: "Minimal reproducible example" + description: "Provide a minimal reproducible example with the code and data necessary to reproduce the bug." + placeholder: "Enter the steps to reproduce the bug" + validations: + required: true + + - type: textarea + id: expected_behavior + attributes: + label: "Expected Behavior" + description: "Describe what you expected to happen." + placeholder: "Enter the expected behavior" + validations: + required: true + + - type: textarea + id: actual_behavior + attributes: + label: "Actual Behavior" + description: "Describe what actually happened when you encountered the bug." + placeholder: "Enter the actual behavior" + validations: + required: true + + - type: textarea + id: additional_context + attributes: + label: "Additional Context" + description: "Provide any other context or information that may be helpful in understanding and fixing the bug." + placeholder: "Enter any additional context" + validations: + required: false + + - type: input + id: environment + attributes: + label: "Environment" + description: "Specify the environment in which the bug occurred (e.g., operating system, browser, application version)." + placeholder: "Enter the environment details" + validations: + required: true + + - type: checkboxes + id: severity + attributes: + label: "Severity" + 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/documentation_request.yml b/.github/ISSUE_TEMPLATE/documentation_request.yml new file mode 100644 index 00000000..6fb074ad --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_request.yml @@ -0,0 +1,39 @@ +name: "Documentation Request" +description: "Help us improve map2loop documentation!" +title: "[Documentation] - " +labels: ["documentation"] +body: + - type: markdown + attributes: + value: | + ## 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. + + - type: input + id: doc_title + attributes: + label: "Documentation Title" + description: "Provide a concise and descriptive title for the documentation request." + placeholder: "Enter the title of the documentation request" + validations: + required: true + + - type: textarea + id: doc_details + attributes: + label: "Documentation Details" + description: "Describe the documentation you would like to see. Include details on why it is needed and how it should be structured." + placeholder: "Enter a detailed description of the documentation" + validations: + required: true + + - type: textarea + id: additional_context + attributes: + label: "Additional Context" + description: "Provide 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.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index bbcbbe7d..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..00872c72 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,77 @@ +name: "Feature Request" +description: "Suggest a new feature or enhancement for map2loop" +title: "[Feature Request] - " +labels: ["enhancement", "feature request"] +body: + - type: markdown + attributes: + value: | + ## Feature Request + + 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: input + id: feature_title + attributes: + label: "Feature Title" + description: "Provide a concise and descriptive title for the feature request." + placeholder: "Enter the title of the feature" + validations: + required: true + + - type: textarea + id: feature_description + attributes: + label: "Feature Description" + description: "Describe the feature you would like to see. Include details on why it is needed and how it should work." + placeholder: "Enter a detailed description of the feature" + validations: + required: true + + - type: textarea + id: current_situation + attributes: + label: "Current Situation" + description: "Describe the current situation and how the absence of this feature affects you." + placeholder: "Explain the current situation and its drawbacks" + validations: + required: true + + - type: textarea + id: proposed_solution + attributes: + label: "Proposed Solution" + description: "Describe how you envision the feature working. Include any specific requirements or details." + placeholder: "Explain how the feature should work" + validations: + required: true + + - type: input + id: additional_context + attributes: + label: "Additional Context" + description: "Provide any other context or information that may be helpful in understanding the feature request." + placeholder: "Enter any additional context" + validations: + required: false + + - type: checkboxes + id: affected_areas + attributes: + label: "Affected Areas" + 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" diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 00000000..65db9e62 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,48 @@ +name: "Question" +description: "Ask a question about map2loop!" +title: "[Question] - " +labels: ["question"] +body: + - type: markdown + attributes: + value: | + ## Question + + Please use this template to ask a question about applying map2loop to your data. + Provide as much detail as possible to help us understand and answer your question efficiently. + + - type: input + id: question_title + attributes: + label: "Question Title" + description: "Provide a concise and descriptive title for your question." + placeholder: "Enter the title of your question" + validations: + required: true + + - type: textarea + id: question_details + attributes: + label: "Question Details" + description: "Describe your question in detail. Include any context or background information that might be helpful." + placeholder: "Enter the details of your question" + validations: + required: true + + - type: textarea + id: relevant_code_snippets + attributes: + label: "Relevant code or data" + description: "If applicable, provide any relevant code snippets or examples related to your question." + placeholder: "Enter any relevant code snippets" + validations: + required: false + + - type: input + id: additional_context + attributes: + label: "Additional Context" + description: "Provide any other context or information that may be helpful in answering your question." + placeholder: "Enter any additional context" + validations: + required: false From 9597a977744e4b7fea91b21d2a661f37ea41f67e Mon Sep 17 00:00:00 2001 From: AngRodrigues Date: Fri, 24 May 2024 08:51:38 +1000 Subject: [PATCH 13/18] fix: add pull request template --- .../ISSUE_TEMPLATE/pull_request_template.yml | 18 +++++++++++++ .../pull_request_template/bug_fix_template.md | 24 +++++++++++++++++ .../docs_update_template.md | 23 ++++++++++++++++ .../pull_request_template/feature_template.md | 27 +++++++++++++++++++ .../tests_improvement_template.md | 23 ++++++++++++++++ 5 files changed, 115 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/pull_request_template.yml create mode 100644 .github/pull_request_template/bug_fix_template.md create mode 100644 .github/pull_request_template/docs_update_template.md create mode 100644 .github/pull_request_template/feature_template.md create mode 100644 .github/pull_request_template/tests_improvement_template.md diff --git a/.github/ISSUE_TEMPLATE/pull_request_template.yml b/.github/ISSUE_TEMPLATE/pull_request_template.yml new file mode 100644 index 00000000..f99ce5c0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/pull_request_template.yml @@ -0,0 +1,18 @@ +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 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/pull_request_template/bug_fix_template.md b/.github/pull_request_template/bug_fix_template.md new file mode 100644 index 00000000..d6f7f7ad --- /dev/null +++ b/.github/pull_request_template/bug_fix_template.md @@ -0,0 +1,24 @@ +## Description + +Please describe the issue that this pull request addresses and summarize the changes. + +Fixes #(issue) + +## Type of change + +- [ ] Bug fix (non-breaking change which fixes an issue) + +## 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 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 unit tests pass locally with my changes diff --git a/.github/pull_request_template/docs_update_template.md b/.github/pull_request_template/docs_update_template.md new file mode 100644 index 00000000..247529c3 --- /dev/null +++ b/.github/pull_request_template/docs_update_template.md @@ -0,0 +1,23 @@ +## 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/feature_template.md b/.github/pull_request_template/feature_template.md new file mode 100644 index 00000000..29a43a6e --- /dev/null +++ b/.github/pull_request_template/feature_template.md @@ -0,0 +1,27 @@ +## Description + +Please include a summary of the changes and the related issue. Include relevant motivation and context, if appropriate. +List any new dependencies that are required for this change. + +Fixes #(issue) + +## Type of change + +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) + +## 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 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 +- [ ] 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 diff --git a/.github/pull_request_template/tests_improvement_template.md b/.github/pull_request_template/tests_improvement_template.md new file mode 100644 index 00000000..78b3bc70 --- /dev/null +++ b/.github/pull_request_template/tests_improvement_template.md @@ -0,0 +1,23 @@ +## Description + +Please include a summary of the added 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 +- [ ] 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 d97b78a02920e2067016e10aa89ade3a33cbe311 Mon Sep 17 00:00:00 2001 From: AngRodrigues Date: Fri, 24 May 2024 09:01:09 +1000 Subject: [PATCH 14/18] fix: few typos grammar --- .github/ISSUE_TEMPLATE/pull_request_template.yml | 2 +- .github/pull_request_template/bug_fix_template.md | 4 ++-- .github/pull_request_template/tests_improvement_template.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/pull_request_template.yml b/.github/ISSUE_TEMPLATE/pull_request_template.yml index f99ce5c0..2fc5462a 100644 --- a/.github/ISSUE_TEMPLATE/pull_request_template.yml +++ b/.github/ISSUE_TEMPLATE/pull_request_template.yml @@ -6,7 +6,7 @@ pull_request_templates: file: pull_request_template/bug_fix_template.md - name: Feature Template - description: Use this template for new features. + description: Use this template for adding new features. file: pull_request_template/feature_template.md - name: Documentation Update Template diff --git a/.github/pull_request_template/bug_fix_template.md b/.github/pull_request_template/bug_fix_template.md index d6f7f7ad..afdc1497 100644 --- a/.github/pull_request_template/bug_fix_template.md +++ b/.github/pull_request_template/bug_fix_template.md @@ -1,6 +1,6 @@ ## Description -Please describe the issue that this pull request addresses and summarize the changes. +Please describe the issue that this pull request addresses and summarize the changes you are implementing. Fixes #(issue) @@ -10,7 +10,7 @@ Fixes #(issue) ## 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: diff --git a/.github/pull_request_template/tests_improvement_template.md b/.github/pull_request_template/tests_improvement_template.md index 78b3bc70..aa56ee86 100644 --- a/.github/pull_request_template/tests_improvement_template.md +++ b/.github/pull_request_template/tests_improvement_template.md @@ -1,6 +1,6 @@ ## Description -Please include a summary of the added test. List relevant functions tested. +Please include a summary of the added or modified test. List relevant functions tested. Fixes #(issue) From 7cb3d47bedf25688add1fa0f68ac476eec5ba2c3 Mon Sep 17 00:00:00 2001 From: AngRodrigues Date: Fri, 24 May 2024 09:40:33 +1000 Subject: [PATCH 15/18] fix: tests should be with pytest --- .github/pull_request_template/tests_improvement_template.md | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/pull_request_template/tests_improvement_template.md b/.github/pull_request_template/tests_improvement_template.md index aa56ee86..58fd8b08 100644 --- a/.github/pull_request_template/tests_improvement_template.md +++ b/.github/pull_request_template/tests_improvement_template.md @@ -17,6 +17,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 - [ ] 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 From a126d02bc2a623719b417fbefdf5bdb09eb968f8 Mon Sep 17 00:00:00 2001 From: AngRodrigues Date: Mon, 27 May 2024 12:46:12 +1000 Subject: [PATCH 16/18] Revert "Update issue templates" --- .github/ISSUE_TEMPLATE/bug_report.yml | 91 ------------------- .../ISSUE_TEMPLATE/documentation_request.yml | 39 -------- .github/ISSUE_TEMPLATE/feature_request.yml | 77 ---------------- .../ISSUE_TEMPLATE/pull_request_template.yml | 18 ---- .github/ISSUE_TEMPLATE/question.yml | 48 ---------- .../pull_request_template/bug_fix_template.md | 24 ----- .../docs_update_template.md | 23 ----- .../pull_request_template/feature_template.md | 27 ------ .../tests_improvement_template.md | 24 ----- 9 files changed, 371 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/documentation_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100644 .github/ISSUE_TEMPLATE/pull_request_template.yml delete mode 100644 .github/ISSUE_TEMPLATE/question.yml 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/feature_template.md delete mode 100644 .github/pull_request_template/tests_improvement_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml deleted file mode 100644 index 8fe9facf..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ /dev/null @@ -1,91 +0,0 @@ -name: "Bug Report" -description: "Report a bug or an issue in map2loop" -title: "[Bug] - " -labels: ["bug"] -body: - - type: markdown - attributes: - value: | - ## Bug Report - Thanks for submitting a bug report to map2loop! - Please use this template to report a bug. Please provide as much detail as possible to help us reproduce and fix the issue efficiently. - - - type: input - id: bug_title - attributes: - label: "Bug Title" - description: "Provide a concise and descriptive title for the bug report." - placeholder: "Enter the title of the bug" - validations: - required: true - - - type: textarea - id: bug_description - attributes: - label: "Bug Description" - description: "Describe the bug you encountered. Include details on what you expected to happen and what actually happened." - placeholder: "Enter a detailed description of the bug" - validations: - required: true - - - type: textarea - id: steps_to_reproduce - attributes: - label: "Minimal reproducible example" - description: "Provide a minimal reproducible example with the code and data necessary to reproduce the bug." - placeholder: "Enter the steps to reproduce the bug" - validations: - required: true - - - type: textarea - id: expected_behavior - attributes: - label: "Expected Behavior" - description: "Describe what you expected to happen." - placeholder: "Enter the expected behavior" - validations: - required: true - - - type: textarea - id: actual_behavior - attributes: - label: "Actual Behavior" - description: "Describe what actually happened when you encountered the bug." - placeholder: "Enter the actual behavior" - validations: - required: true - - - type: textarea - id: additional_context - attributes: - label: "Additional Context" - description: "Provide any other context or information that may be helpful in understanding and fixing the bug." - placeholder: "Enter any additional context" - validations: - required: false - - - type: input - id: environment - attributes: - label: "Environment" - description: "Specify the environment in which the bug occurred (e.g., operating system, browser, application version)." - placeholder: "Enter the environment details" - validations: - required: true - - - type: checkboxes - id: severity - attributes: - label: "Severity" - 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/documentation_request.yml b/.github/ISSUE_TEMPLATE/documentation_request.yml deleted file mode 100644 index 6fb074ad..00000000 --- a/.github/ISSUE_TEMPLATE/documentation_request.yml +++ /dev/null @@ -1,39 +0,0 @@ -name: "Documentation Request" -description: "Help us improve map2loop documentation!" -title: "[Documentation] - " -labels: ["documentation"] -body: - - type: markdown - attributes: - value: | - ## 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. - - - type: input - id: doc_title - attributes: - label: "Documentation Title" - description: "Provide a concise and descriptive title for the documentation request." - placeholder: "Enter the title of the documentation request" - validations: - required: true - - - type: textarea - id: doc_details - attributes: - label: "Documentation Details" - description: "Describe the documentation you would like to see. Include details on why it is needed and how it should be structured." - placeholder: "Enter a detailed description of the documentation" - validations: - required: true - - - type: textarea - id: additional_context - attributes: - label: "Additional Context" - description: "Provide 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 deleted file mode 100644 index 00872c72..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ /dev/null @@ -1,77 +0,0 @@ -name: "Feature Request" -description: "Suggest a new feature or enhancement for map2loop" -title: "[Feature Request] - " -labels: ["enhancement", "feature request"] -body: - - type: markdown - attributes: - value: | - ## Feature Request - - 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: input - id: feature_title - attributes: - label: "Feature Title" - description: "Provide a concise and descriptive title for the feature request." - placeholder: "Enter the title of the feature" - validations: - required: true - - - type: textarea - id: feature_description - attributes: - label: "Feature Description" - description: "Describe the feature you would like to see. Include details on why it is needed and how it should work." - placeholder: "Enter a detailed description of the feature" - validations: - required: true - - - type: textarea - id: current_situation - attributes: - label: "Current Situation" - description: "Describe the current situation and how the absence of this feature affects you." - placeholder: "Explain the current situation and its drawbacks" - validations: - required: true - - - type: textarea - id: proposed_solution - attributes: - label: "Proposed Solution" - description: "Describe how you envision the feature working. Include any specific requirements or details." - placeholder: "Explain how the feature should work" - validations: - required: true - - - type: input - id: additional_context - attributes: - label: "Additional Context" - description: "Provide any other context or information that may be helpful in understanding the feature request." - placeholder: "Enter any additional context" - validations: - required: false - - - type: checkboxes - id: affected_areas - attributes: - label: "Affected Areas" - 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" 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 deleted file mode 100644 index 65db9e62..00000000 --- a/.github/ISSUE_TEMPLATE/question.yml +++ /dev/null @@ -1,48 +0,0 @@ -name: "Question" -description: "Ask a question about map2loop!" -title: "[Question] - " -labels: ["question"] -body: - - type: markdown - attributes: - value: | - ## Question - - Please use this template to ask a question about applying map2loop to your data. - Provide as much detail as possible to help us understand and answer your question efficiently. - - - type: input - id: question_title - attributes: - label: "Question Title" - description: "Provide a concise and descriptive title for your question." - placeholder: "Enter the title of your question" - validations: - required: true - - - type: textarea - id: question_details - attributes: - label: "Question Details" - description: "Describe your question in detail. Include any context or background information that might be helpful." - placeholder: "Enter the details of your question" - validations: - required: true - - - type: textarea - id: relevant_code_snippets - attributes: - label: "Relevant code or data" - description: "If applicable, provide any relevant code snippets or examples related to your question." - placeholder: "Enter any relevant code snippets" - validations: - required: false - - - type: input - id: additional_context - attributes: - label: "Additional Context" - description: "Provide any other context or information that may be helpful in answering your question." - placeholder: "Enter any additional context" - validations: - required: false 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 afdc1497..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 unit tests pass locally with my changes 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/feature_template.md b/.github/pull_request_template/feature_template.md deleted file mode 100644 index 29a43a6e..00000000 --- a/.github/pull_request_template/feature_template.md +++ /dev/null @@ -1,27 +0,0 @@ -## Description - -Please include a summary of the changes and the related issue. Include relevant motivation and context, if appropriate. -List any new dependencies that are required for this change. - -Fixes #(issue) - -## Type of change - -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - -## 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 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 -- [ ] 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 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 58fd8b08..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 -- [ ] 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 aef79d6bbc062acd93b7ca718968536be7e5150b Mon Sep 17 00:00:00 2001 From: AngRodrigues Date: Tue, 28 May 2024 11:16:23 +1000 Subject: [PATCH 17/18] fix: add issue templates back --- .github/ISSUE_TEMPLATE/bug_report.yml | 87 +++++++++++++++++++ .../ISSUE_TEMPLATE/documentation_request.yml | 37 ++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 69 +++++++++++++++ .../ISSUE_TEMPLATE/pull_request_template.yml | 18 ++++ .github/ISSUE_TEMPLATE/question.yml | 46 ++++++++++ .../pull_request_template/bug_fix_remplate.md | 24 +++++ .../docs_update_template.md | 23 +++++ .../pull_request_template/feature_template.md | 27 ++++++ .../test_improvement_template.md | 24 +++++ 9 files changed, 355 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/documentation_request.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml create mode 100644 .github/ISSUE_TEMPLATE/pull_request_template.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml create mode 100644 .github/pull_request_template/bug_fix_remplate.md create mode 100644 .github/pull_request_template/docs_update_template.md create mode 100644 .github/pull_request_template/feature_template.md create mode 100644 .github/pull_request_template/test_improvement_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..b96a5204 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,87 @@ +name: "Bug Report" +description: "Report a bug or an issue in map2loop" +title: "[Bug] - " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + ## Bug Report + Thanks for submitting a bug report to map2loop! + Please use this template to report a bug. Please provide as much detail as possible to help us reproduce and fix the issue efficiently. + + - type: input + id: bug_title + attributes: + label: "Bug Title" + description: "Provide a concise and descriptive title for the bug report." + placeholder: "Enter the title of the bug" + validations: + required: true + + - type: textarea + id: bug_description + attributes: + label: "Bug Description" + description: "Describe the bug you encountered. Include details on what you expected to happen and what actually happened." + placeholder: "Enter a detailed description of the bug" + validations: + required: true + + - type: textarea + id: steps_to_reproduce + attributes: + label: "Minimal reproducible example" + description: "Provide a minimal reproducible example with the code and data necessary to reproduce the bug." + placeholder: "Enter the steps to reproduce the bug" + validations: + required: true + + - type: textarea + id: expected_behavior + attributes: + label: "Expected Behavior" + description: "Describe what you expected to happen." + placeholder: "Enter the expected behavior" + validations: + required: true + + - type: textarea + id: actual_behavior + attributes: + label: "Actual Behavior" + description: "Describe what actually happened when you encountered the bug." + placeholder: "Enter the actual behavior" + validations: + required: true + + - type: textarea + id: additional_context + attributes: + label: "Additional Context" + description: "Provide any other context or information that may be helpful in understanding and fixing the bug." + placeholder: "Enter any additional context" + validations: + required: false + + - type: input + id: environment + attributes: + label: "Environment" + description: "Specify the environment in which the bug occurred (e.g., operating system, browser, application version)." + placeholder: "Enter the environment details" + validations: + required: true + + - type: checkboxes + id: severity + attributes: + label: "Severity" + description: "Select the severity level of the bug." + options: + - label: "Low" + - label: "Medium" + - label: "High" + - label: "Critical" + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/documentation_request.yml b/.github/ISSUE_TEMPLATE/documentation_request.yml new file mode 100644 index 00000000..d275cc6c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_request.yml @@ -0,0 +1,37 @@ +name: "Documentation Request" +description: "Help us improve map2loop documentation!" +title: "[Documentation] - " +labels: ["documentation"] +body: + - type: markdown + attributes: + value: | + ## 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. + - type: input + id: doc_title + attributes: + label: "Documentation Title" + description: "Provide a concise and descriptive title for the documentation request." + placeholder: "Enter the title of the documentation request" + validations: + required: true + + - type: textarea + id: doc_details + attributes: + label: "Documentation Details" + description: "Describe the documentation you would like to see. Include details on why it is needed and how it should be structured." + placeholder: "Enter a detailed description of the documentation" + validations: + required: true + + - type: textarea + id: additional_context + attributes: + label: "Additional Context" + description: "Provide any other context or information that may be helpful." + placeholder: "Enter any additional context" + validations: + required: false \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 00000000..c18daa34 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,69 @@ +name: "Feature Request" +description: "Suggest a new feature or enhancement for map2loop" +title: "[Feature Request] - " +labels: ["enhancement", "feature request"] +body: + - type: markdown + attributes: + value: | + ## Feature Request + 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: input + id: feature_title + attributes: + label: "Feature Title" + description: "Provide a concise and descriptive title for the feature request." + placeholder: "Enter the title of the feature" + validations: + required: true + + - type: textarea + id: feature_description + attributes: + label: "Feature Description" + description: "Describe the feature you would like to see. Include details on why it is needed and how it should work." + placeholder: "Enter a detailed description of the feature" + validations: + required: true + + - type: textarea + id: current_situation + attributes: + label: "Current Situation" + description: "Describe the current situation and how the absence of this feature affects you." + placeholder: "Explain the current situation and its drawbacks" + validations: + required: true + + - type: textarea + id: proposed_solution + attributes: + label: "Proposed Solution" + description: "Describe how you envision the feature working. Include any specific requirements or details." + placeholder: "Explain how the feature should work" + validations: + required: true + + - type: input + id: additional_context + attributes: + label: "Additional Context" + description: "Provide any other context or information that may be helpful in understanding the feature request." + placeholder: "Enter any additional context" + validations: + required: false + + - type: checkboxes + id: affected_areas + attributes: + label: "Affected Areas" + description: "Select the areas of the project that this feature request impacts." + options: + - label: "input data" + - label: "project creation" + - label: "samplers" + - label: "sorters" + - label: "stratigraphic column" + - label: "data types" + - label: "faults" + - label: "Other" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/pull_request_template.yml b/.github/ISSUE_TEMPLATE/pull_request_template.yml new file mode 100644 index 00000000..bba4e8d7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/pull_request_template.yml @@ -0,0 +1,18 @@ +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 diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 00000000..1348b55c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,46 @@ +name: "Question" +description: "Ask a question about map2loop!" +title: "[Question] - " +labels: ["question"] +body: + - type: markdown + attributes: + value: | + ## Question + Please use this template to ask a question about applying map2loop to your data. + Provide as much detail as possible to help us understand and answer your question efficiently. + - type: input + id: question_title + attributes: + label: "Question Title" + description: "Provide a concise and descriptive title for your question." + placeholder: "Enter the title of your question" + validations: + required: true + + - type: textarea + id: question_details + attributes: + label: "Question Details" + description: "Describe your question in detail. Include any context or background information that might be helpful." + placeholder: "Enter the details of your question" + validations: + required: true + + - type: textarea + id: relevant_code_snippets + attributes: + label: "Relevant code or data" + description: "If applicable, provide any relevant code snippets or examples related to your question." + placeholder: "Enter any relevant code snippets" + validations: + required: false + + - type: input + id: additional_context + attributes: + label: "Additional Context" + description: "Provide any other context or information that may be helpful in answering your question." + placeholder: "Enter any additional context" + validations: + required: false \ No newline at end of file diff --git a/.github/pull_request_template/bug_fix_remplate.md b/.github/pull_request_template/bug_fix_remplate.md new file mode 100644 index 00000000..afdc1497 --- /dev/null +++ b/.github/pull_request_template/bug_fix_remplate.md @@ -0,0 +1,24 @@ +## 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 unit tests pass locally with my changes diff --git a/.github/pull_request_template/docs_update_template.md b/.github/pull_request_template/docs_update_template.md new file mode 100644 index 00000000..99c76ba5 --- /dev/null +++ b/.github/pull_request_template/docs_update_template.md @@ -0,0 +1,23 @@ +## 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 \ No newline at end of file diff --git a/.github/pull_request_template/feature_template.md b/.github/pull_request_template/feature_template.md new file mode 100644 index 00000000..29a43a6e --- /dev/null +++ b/.github/pull_request_template/feature_template.md @@ -0,0 +1,27 @@ +## Description + +Please include a summary of the changes and the related issue. Include relevant motivation and context, if appropriate. +List any new dependencies that are required for this change. + +Fixes #(issue) + +## Type of change + +- [ ] New feature (non-breaking change which adds functionality) +- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) + +## 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 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 +- [ ] 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 diff --git a/.github/pull_request_template/test_improvement_template.md b/.github/pull_request_template/test_improvement_template.md new file mode 100644 index 00000000..0be02d03 --- /dev/null +++ b/.github/pull_request_template/test_improvement_template.md @@ -0,0 +1,24 @@ +## 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 +- [ ] 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 \ No newline at end of file From 79d4169226bf1a3df5bd8b70bf86717bed52f781 Mon Sep 17 00:00:00 2001 From: AngRodrigues Date: Tue, 28 May 2024 11:40:57 +1000 Subject: [PATCH 18/18] fix: correct grammar for clarity --- .github/pull_request_template/bug_fix_remplate.md | 4 ++-- .github/pull_request_template/docs_update_template.md | 4 ++-- .github/pull_request_template/feature_template.md | 4 ++-- .github/pull_request_template/test_improvement_template.md | 6 +++--- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/pull_request_template/bug_fix_remplate.md b/.github/pull_request_template/bug_fix_remplate.md index afdc1497..f2e4c85b 100644 --- a/.github/pull_request_template/bug_fix_remplate.md +++ b/.github/pull_request_template/bug_fix_remplate.md @@ -15,8 +15,8 @@ Provide branch name so we can reproduce. ## Checklist: -- [ ] This branch is up-to-date with master -- [ ] All gh-action checks are passing +- [ ] This branch is up-to-date with the master branch +- [ ] All github-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 diff --git a/.github/pull_request_template/docs_update_template.md b/.github/pull_request_template/docs_update_template.md index 99c76ba5..a1c43359 100644 --- a/.github/pull_request_template/docs_update_template.md +++ b/.github/pull_request_template/docs_update_template.md @@ -14,8 +14,8 @@ Provide branch name so we can reproduce. ## Checklist: -- [ ] This branch is up-to-date with master -- [ ] All gh-action checks are passing +- [ ] This branch is up-to-date with the master branch +- [ ] All github-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 diff --git a/.github/pull_request_template/feature_template.md b/.github/pull_request_template/feature_template.md index 29a43a6e..3b6e6313 100644 --- a/.github/pull_request_template/feature_template.md +++ b/.github/pull_request_template/feature_template.md @@ -17,8 +17,8 @@ Provide branch name so we can reproduce. ## Checklist: -- [ ] This branch is up-to-date with master -- [ ] All gh-action checks are passing +- [ ] This branch is up-to-date with the master branch +- [ ] All github-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 diff --git a/.github/pull_request_template/test_improvement_template.md b/.github/pull_request_template/test_improvement_template.md index 0be02d03..56e082bc 100644 --- a/.github/pull_request_template/test_improvement_template.md +++ b/.github/pull_request_template/test_improvement_template.md @@ -13,10 +13,10 @@ Fixes #(issue) Please describe the tests that you ran to verify your changes. Provide branch name so we can reproduce. -## Checklist: +## Checklist: -- [ ] This branch is up-to-date with master -- [ ] All gh-action checks are passing +- [ ] This branch is up-to-date with the master branch +- [ ] All github-action checks are passing - [ ] My tests run with pytest from the map2loop folder - [ ] I have performed a self-review of my own tests - [ ] My tests follow the style guidelines of this project