From ba4150481f2f1eacd09600d6f917ea73d2141a62 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Fri, 10 Oct 2025 20:04:22 +0800 Subject: [PATCH 01/10] Add an issue template for wrapping GMT modules --- .github/ISSUE_TEMPLATE/2-feature_request.yaml | 2 +- .github/ISSUE_TEMPLATE/3-module_request.md | 30 ++++++++++++++ .github/ISSUE_TEMPLATE/3-module_request.yaml | 41 ------------------- 3 files changed, 31 insertions(+), 42 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/3-module_request.md delete mode 100644 .github/ISSUE_TEMPLATE/3-module_request.yaml diff --git a/.github/ISSUE_TEMPLATE/2-feature_request.yaml b/.github/ISSUE_TEMPLATE/2-feature_request.yaml index 096ea2b283d..c7ccd12ce92 100644 --- a/.github/ISSUE_TEMPLATE/2-feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/2-feature_request.yaml @@ -1,4 +1,4 @@ -name: Feature request - General feature +name: Feature request description: Request the addition of a new feature/functionality labels: ["feature request"] body: diff --git a/.github/ISSUE_TEMPLATE/3-module_request.md b/.github/ISSUE_TEMPLATE/3-module_request.md new file mode 100644 index 00000000000..2d12d608097 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-module_request.md @@ -0,0 +1,30 @@ +--- +name: Wrapper for a GMT module +about: Track the progress of wrapping a GMT module. [For project maintainers only!] +title: "Wrapper: Description of the module" +labels: ["feature request"] + +--- + +*This issue is the central place for discussing the implementation of the method. The progress is tracked at https://github.com/orgs/GenericMappingTools/projects/3.* + +## Documentation + +- GMT: https://docs.generic-mapping-tools.org/dev/.html +- GMT.jl: https://www.generic-mapping-tools.org/GMTjl_doc/documentation/modules/ +- PyGMT: https://www.pygmt.org/dev/api/generated/.html + +## Linked PRs + +- [ ] Initial feature implementation +- [ ] Add a tutorial/gallery example + +## GMT Option Flags + +*Checked: Implemented; Unchecked: To be implemented/discussed; Strikethrough: Won't implement.* + +- [ ] `-R`: `region` #XXX +- [ ] `-J`: `projection` #XXX +- [ ] ... + +## Notes on input formats diff --git a/.github/ISSUE_TEMPLATE/3-module_request.yaml b/.github/ISSUE_TEMPLATE/3-module_request.yaml deleted file mode 100644 index 3c6d6377c04..00000000000 --- a/.github/ISSUE_TEMPLATE/3-module_request.yaml +++ /dev/null @@ -1,41 +0,0 @@ -name: Feature request - Wrap a new GMT module -description: Request PyGMT wrapper for a GMT module -title: "Wrapper for " -labels: ["feature request"] -body: - - type: markdown - attributes: - value: > - Please replace `` in the issue title and the description with the - name of the requested module and add the description of the module. - - type: textarea - id: which-module - attributes: - label: Description of the desired module - description: > - Please be as detailed as you can in your description. If possible, include - an example of how you would like to use this feature (even better if it's a code example). - placeholder: > - Implement [``](https://docs.generic-mapping-tools.org/latest/.html) - which ``. - validations: - required: true - - type: dropdown - id: help - attributes: - label: Are you willing to help implement and maintain this feature? - description: > - Every feature we add is code that we will have to maintain and keep updated. - This takes a lot of effort. If you are willing to be involved in the project and - help maintain your feature, it will make it easier for us to accept it. - options: - - "No" - - "Yes" - - "Maybe" - validations: - required: true - - type: markdown - attributes: - value: > - Progress on wrapping the module will be tracked in the - [project board](https://github.com/orgs/GenericMappingTools/projects/3). From 7bd77ffe612d914c4b13565d252a72f2fd8945c0 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Sun, 12 Oct 2025 23:55:22 +0800 Subject: [PATCH 02/10] Update module template --- .github/ISSUE_TEMPLATE/3-module_request.md | 28 ++++++++++++++-------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/3-module_request.md b/.github/ISSUE_TEMPLATE/3-module_request.md index 2d12d608097..bfe4ee867c4 100644 --- a/.github/ISSUE_TEMPLATE/3-module_request.md +++ b/.github/ISSUE_TEMPLATE/3-module_request.md @@ -6,7 +6,8 @@ labels: ["feature request"] --- -*This issue is the central place for discussing the implementation of the method. The progress is tracked at https://github.com/orgs/GenericMappingTools/projects/3.* +*This issue serves as the central place for discussing and tracking the implementation of the `` method in PyGMT.* +*The issue will be closed when the initial implementation is complete. Progress is tracked at https://github.com/orgs/GenericMappingTools/projects/3.* ## Documentation @@ -14,17 +15,24 @@ labels: ["feature request"] - GMT.jl: https://www.generic-mapping-tools.org/GMTjl_doc/documentation/modules/ - PyGMT: https://www.pygmt.org/dev/api/generated/.html -## Linked PRs - -- [ ] Initial feature implementation -- [ ] Add a tutorial/gallery example - ## GMT Option Flags -*Checked: Implemented; Unchecked: To be implemented/discussed; Strikethrough: Won't implement.* +*☑️: Implemented; ⬜: To be implemented/discussed; ~~Strikethrough~~: Won’t implement.* -- [ ] `-R`: `region` #XXX -- [ ] `-J`: `projection` #XXX +- [ ] `-R`: `region` #XXX @XXX +- [ ] `-J`: `projection` #XXX @XXX - [ ] ... -## Notes on input formats +## Notes on Input Formats + +*Add any notes on the input formats, especially the meaning of columns.* + +## Linked Pull Requests + +- [ ] Initial feature implementation +- [ ] Add a tutorial or gallery example + +## Related Issues and Discussions + +*Add links to related wrapper discussions, API design threads, or upstream GMT changes here.* + From d8436ec1db983d51592f41087c2948ac74fe165e Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Sun, 12 Oct 2025 23:56:55 +0800 Subject: [PATCH 03/10] Update template --- .github/ISSUE_TEMPLATE/3-module_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/3-module_request.md b/.github/ISSUE_TEMPLATE/3-module_request.md index bfe4ee867c4..22e2e94e697 100644 --- a/.github/ISSUE_TEMPLATE/3-module_request.md +++ b/.github/ISSUE_TEMPLATE/3-module_request.md @@ -29,7 +29,7 @@ labels: ["feature request"] ## Linked Pull Requests -- [ ] Initial feature implementation +- [ ] Initial feature implementation #XXX @XXX - [ ] Add a tutorial or gallery example ## Related Issues and Discussions From c883ffc71267d6cd15bbd17d2b28d4093337f100 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 13 Oct 2025 09:09:26 +0800 Subject: [PATCH 04/10] Fix style --- .github/ISSUE_TEMPLATE/3-module_request.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/3-module_request.md b/.github/ISSUE_TEMPLATE/3-module_request.md index 22e2e94e697..fde781965a0 100644 --- a/.github/ISSUE_TEMPLATE/3-module_request.md +++ b/.github/ISSUE_TEMPLATE/3-module_request.md @@ -35,4 +35,3 @@ labels: ["feature request"] ## Related Issues and Discussions *Add links to related wrapper discussions, API design threads, or upstream GMT changes here.* - From e62bca800af3b0ad05242374dbbc9cc51336d963 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 13 Oct 2025 10:30:42 +0800 Subject: [PATCH 05/10] Format the template --- .github/ISSUE_TEMPLATE/3-module_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/3-module_request.md b/.github/ISSUE_TEMPLATE/3-module_request.md index fde781965a0..56e9bfad4aa 100644 --- a/.github/ISSUE_TEMPLATE/3-module_request.md +++ b/.github/ISSUE_TEMPLATE/3-module_request.md @@ -17,7 +17,7 @@ labels: ["feature request"] ## GMT Option Flags -*☑️: Implemented; ⬜: To be implemented/discussed; ~~Strikethrough~~: Won’t implement.* +☑️: *Implemented*; ⬜: *To be implemented/discussed*; ~~Strikethrough~~: *Won’t implement*. - [ ] `-R`: `region` #XXX @XXX - [ ] `-J`: `projection` #XXX @XXX From f35a0eba654e31f54304b92d676e066fa5008e51 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 13 Oct 2025 19:22:58 +0800 Subject: [PATCH 06/10] Update .github/ISSUE_TEMPLATE/3-module_request.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/3-module_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/3-module_request.md b/.github/ISSUE_TEMPLATE/3-module_request.md index 56e9bfad4aa..4ae53a01699 100644 --- a/.github/ISSUE_TEMPLATE/3-module_request.md +++ b/.github/ISSUE_TEMPLATE/3-module_request.md @@ -17,7 +17,7 @@ labels: ["feature request"] ## GMT Option Flags -☑️: *Implemented*; ⬜: *To be implemented/discussed*; ~~Strikethrough~~: *Won’t implement*. +☑️: *Implemented*; ⬜: *To be implemented/discussed*; ~~Strikethrough~~: *Won't implement*. - [ ] `-R`: `region` #XXX @XXX - [ ] `-J`: `projection` #XXX @XXX From 4365efd67c3e4d8603dea76b3a3874c4929f075f Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Wed, 15 Oct 2025 10:08:42 +0800 Subject: [PATCH 07/10] Reforamt --- .github/ISSUE_TEMPLATE/3-module_request.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/3-module_request.md b/.github/ISSUE_TEMPLATE/3-module_request.md index 4ae53a01699..0727534ecd0 100644 --- a/.github/ISSUE_TEMPLATE/3-module_request.md +++ b/.github/ISSUE_TEMPLATE/3-module_request.md @@ -6,8 +6,7 @@ labels: ["feature request"] --- -*This issue serves as the central place for discussing and tracking the implementation of the `` method in PyGMT.* -*The issue will be closed when the initial implementation is complete. Progress is tracked at https://github.com/orgs/GenericMappingTools/projects/3.* +*This issue serves as the central place for discussing and tracking the implementation of the `` method in PyGMT. The issue will be closed when the initial implementation is complete. Progress is tracked at https://github.com/orgs/GenericMappingTools/projects/3.* ## Documentation From f00393a848be0b1096d3524e366de3929d1871f3 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Wed, 15 Oct 2025 10:18:40 +0800 Subject: [PATCH 08/10] Add common option flags -U/-X/-Y --- .github/ISSUE_TEMPLATE/3-module_request.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/ISSUE_TEMPLATE/3-module_request.md b/.github/ISSUE_TEMPLATE/3-module_request.md index 0727534ecd0..e0edb6c5588 100644 --- a/.github/ISSUE_TEMPLATE/3-module_request.md +++ b/.github/ISSUE_TEMPLATE/3-module_request.md @@ -21,6 +21,10 @@ labels: ["feature request"] - [ ] `-R`: `region` #XXX @XXX - [ ] `-J`: `projection` #XXX @XXX - [ ] ... +- [ ] ~~`-U`~~: Use `Figure.timestamp` instead. +- [ ] ~~`-X`/`-Y`~~: Use `Figure.shift_origin` instead. +- [ ] ~~`--PAR=value`~~: Use `pygmt.config` instead. + ## Notes on Input Formats From a2ec8650a1e147820bdcfc5af59346bf58260bc0 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Wed, 15 Oct 2025 21:10:53 +0800 Subject: [PATCH 09/10] Update .github/ISSUE_TEMPLATE/3-module_request.md [skip ci] MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/3-module_request.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/3-module_request.md b/.github/ISSUE_TEMPLATE/3-module_request.md index e0edb6c5588..72d3b442104 100644 --- a/.github/ISSUE_TEMPLATE/3-module_request.md +++ b/.github/ISSUE_TEMPLATE/3-module_request.md @@ -14,7 +14,7 @@ labels: ["feature request"] - GMT.jl: https://www.generic-mapping-tools.org/GMTjl_doc/documentation/modules/ - PyGMT: https://www.pygmt.org/dev/api/generated/.html -## GMT Option Flags +## GMT Option Flags and Modifieres ☑️: *Implemented*; ⬜: *To be implemented/discussed*; ~~Strikethrough~~: *Won't implement*. From 98cc3b68a1bcf38d828843f5c55c43a2633bddc9 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Wed, 15 Oct 2025 21:11:12 +0800 Subject: [PATCH 10/10] Update .github/ISSUE_TEMPLATE/3-module_request.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/3-module_request.md | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/3-module_request.md b/.github/ISSUE_TEMPLATE/3-module_request.md index 72d3b442104..7a118774d9a 100644 --- a/.github/ISSUE_TEMPLATE/3-module_request.md +++ b/.github/ISSUE_TEMPLATE/3-module_request.md @@ -25,7 +25,6 @@ labels: ["feature request"] - [ ] ~~`-X`/`-Y`~~: Use `Figure.shift_origin` instead. - [ ] ~~`--PAR=value`~~: Use `pygmt.config` instead. - ## Notes on Input Formats *Add any notes on the input formats, especially the meaning of columns.*