Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 0 additions & 31 deletions .github/ISSUE_TEMPLATE/module_request.md

This file was deleted.

42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/module_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Feature request - Wrap new GMT module
description: Request PyGMT wrapper for a GMT module
title: "Wrapper for <module-name>"
labels: ["feature request"]
body:
- type: markdown
attributes:
value: |
Please replace <module-name> 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 [`<module-name>`](https://docs.generic-mapping-tools.org/latest/<module-name>.html) which `<insert description of the GMT module>`.
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: |
**Checklist for wrapping GMT Module**

<!-- Please do not edit this section when submitting pull requests. This checklist will help track progress on wrapping the module. -->

- [ ] 'Initial feature implementation' Pull Request (PR)
- [ ] 'Add missing aliases to module' documentation PR
- [ ] 'Support additional functionality in module' PR (optional)
- [ ] 'Add gallery example for module' documentation PR
- [ ] 'Add tutorial for module' documentation PR (optional)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just want to confirm that we want to keep this section in the feature request template, versus using the project board as suggested #1687 (comment). I don't have a strong opinion here, but if we are going to remove it in favor of the project board now's a good time to do so.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm OK with using the project board. We can remove this checklist and add a link to the project board.

Copy link
Member Author

@seisman seisman Dec 1, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 08615d5