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..7a118774d9a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-module_request.md @@ -0,0 +1,39 @@ +--- +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 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 + +- 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 + +## GMT Option Flags and Modifieres + +☑️: *Implemented*; ⬜: *To be implemented/discussed*; ~~Strikethrough~~: *Won't implement*. + +- [ ] `-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 + +*Add any notes on the input formats, especially the meaning of columns.* + +## Linked Pull Requests + +- [ ] Initial feature implementation #XXX @XXX +- [ ] Add a tutorial or gallery example + +## Related Issues and Discussions + +*Add links to related wrapper discussions, API design threads, or upstream GMT changes here.* 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).