Skip to content

Commit 8259159

Browse files
Add an issue template for wrapping GMT modules (#4152)
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
1 parent a90e630 commit 8259159

File tree

3 files changed

+40
-42
lines changed

3 files changed

+40
-42
lines changed

.github/ISSUE_TEMPLATE/2-feature_request.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Feature request - General feature
1+
name: Feature request
22
description: Request the addition of a new feature/functionality
33
labels: ["feature request"]
44
body:
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Wrapper for a GMT module
3+
about: Track the progress of wrapping a GMT module. [For project maintainers only!]
4+
title: "Wrapper: Description of the module"
5+
labels: ["feature request"]
6+
7+
---
8+
9+
*This issue serves as the central place for discussing and tracking the implementation of the `<wrapper>` 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.*
10+
11+
## Documentation
12+
13+
- GMT: https://docs.generic-mapping-tools.org/dev/<module>.html
14+
- GMT.jl: https://www.generic-mapping-tools.org/GMTjl_doc/documentation/modules/<module>
15+
- PyGMT: https://www.pygmt.org/dev/api/generated/<wrapper>.html
16+
17+
## GMT Option Flags and Modifieres
18+
19+
☑️: *Implemented*; ⬜: *To be implemented/discussed*; ~~Strikethrough~~: *Won't implement*.
20+
21+
- [ ] `-R`: `region` #XXX @XXX
22+
- [ ] `-J`: `projection` #XXX @XXX
23+
- [ ] ...
24+
- [ ] ~~`-U`~~: Use `Figure.timestamp` instead.
25+
- [ ] ~~`-X`/`-Y`~~: Use `Figure.shift_origin` instead.
26+
- [ ] ~~`--PAR=value`~~: Use `pygmt.config` instead.
27+
28+
## Notes on Input Formats
29+
30+
*Add any notes on the input formats, especially the meaning of columns.*
31+
32+
## Linked Pull Requests
33+
34+
- [ ] Initial feature implementation #XXX @XXX
35+
- [ ] Add a tutorial or gallery example
36+
37+
## Related Issues and Discussions
38+
39+
*Add links to related wrapper discussions, API design threads, or upstream GMT changes here.*

.github/ISSUE_TEMPLATE/3-module_request.yaml

Lines changed: 0 additions & 41 deletions
This file was deleted.

0 commit comments

Comments
 (0)