pygmt icon indicating copy to clipboard operation
pygmt copied to clipboard

Use yaml configured issue forms?

Open maxrjones opened this issue 3 years ago • 3 comments

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 avatar Aug 11 '22 16:08 maxrjones

Looks great!

seisman avatar Aug 12 '22 01:08 seisman

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:

  • [x] Bug report #2091
  • [ ] Bump GMT version checklist
  • [x] Feature request - General feature #2214
  • [x] Feature request - Wrap new GMT module #2216
  • [ ] PyGMT release checklist

weiji14 avatar Aug 29 '22 19:08 weiji14

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 🚀

maxrjones avatar Aug 29 '22 20:08 maxrjones

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.

seisman avatar Nov 30 '22 14:11 seisman

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

maxrjones avatar Nov 30 '22 16:11 maxrjones