Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert module request issue template into yaml configured form #2216

Merged
merged 4 commits into from
Dec 5, 2022
Merged
Show file tree
Hide file tree
Changes from all 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.

34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/module_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Feature request - Wrap a 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: |
Progress on wrapping the module will be tracked in the [project board](https://github.com/GenericMappingTools/pygmt/projects/9).