-
Notifications
You must be signed in to change notification settings - Fork 233
Convert module request issue template into yaml configured form #2216
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done in 08615d5