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

Use yaml configured issue forms? #2050

Closed
maxrjones opened this issue Aug 11, 2022 · 5 comments
Closed

Use yaml configured issue forms? #2050

maxrjones opened this issue Aug 11, 2022 · 5 comments
Labels
maintenance Boring but important stuff for the core devs
Milestone

Comments

@maxrjones
Copy link
Member

Description of the desired feature

The YAML configured issue forms are nice because they provide more obvious structure relative to the markdown issue templates and automatically format Python code. I could convert the current markdown issue templates to yaml if people agree that this would be a good change. An example of the 'new issue' format using yaml is below (from xarray):
image

Are you willing to help implement and maintain this feature? Yes

@maxrjones maxrjones added question Further information is requested feature request New feature wanted labels Aug 11, 2022
@seisman
Copy link
Member

seisman commented Aug 12, 2022

Looks great!

@seisman seisman added maintenance Boring but important stuff for the core devs and removed question Further information is requested feature request New feature wanted labels Aug 12, 2022
@seisman seisman added this to the 0.8.0 milestone Aug 12, 2022
@weiji14
Copy link
Member

weiji14 commented Aug 29, 2022

Can I work on this @maxrjones? Got some time to spare right now so I can open a PR. Edit: went ahead and started one for the bug report template at #2091

Did we want to also use YAML configured issue forms for feature requests or any of the other items under https://github.com/GenericMappingTools/pygmt/issues/new/choose?

image

TODO list:

@maxrjones
Copy link
Member Author

Did we want to also use YAML configured issue forms for feature requests or any of the other items under https://github.com/GenericMappingTools/pygmt/issues/new/choose?

I generally prefer the rendering of the YAML configuration. Please go ahead with any of them. Thanks for working on this 🚀

@seisman
Copy link
Member

seisman commented Nov 30, 2022

Do we really need to convert the "Bump GMT version checklist" and "PyGMT release checklist" templates to YAML format? The original Markdown format looks easier to maintain than the YAML foramt.

@maxrjones
Copy link
Member Author

Do we really need to convert the "Bump GMT version checklist" and "PyGMT release checklist" templates to YAML format? The original Markdown format looks easier to maintain than the YAML foramt.

I agree that these seem fine as is

@seisman seisman closed this as completed 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

No branches or pull requests

3 participants