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

Conversation

seisman
Copy link
Member

@seisman seisman commented Nov 29, 2022

Description of proposed changes

Address #2050.

Preview at https://github.com/GenericMappingTools/pygmt/blob/yaml-module-request/.github/ISSUE_TEMPLATE/module_request.yaml

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If wrapping a new module, open a 'Wrap new GMT module' issue and submit reasonably-sized PRs.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@seisman seisman added the maintenance Boring but important stuff for the core devs label Nov 29, 2022
@seisman seisman added this to the 0.8.0 milestone Nov 29, 2022
@seisman seisman added the needs review This PR has higher priority and needs review. label Nov 30, 2022
Comment on lines 31 to 42
- 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

@seisman seisman force-pushed the yaml-module-request branch from 4435918 to 08615d5 Compare December 1, 2022 10:31
@seisman seisman requested review from maxrjones and a team December 2, 2022 14:36
@seisman seisman added final review call This PR requires final review and approval from a second reviewer and removed needs review This PR has higher priority and needs review. labels Dec 5, 2022
@seisman seisman merged commit 19ab033 into main Dec 5, 2022
@seisman seisman deleted the yaml-module-request branch December 5, 2022 14:47
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label Dec 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants