Convert bug report markdown issue template into yaml configured form#2091
Merged
Convert bug report markdown issue template into yaml configured form#2091
Conversation
A more structured and user friendly way of filling out bug reports. Syntax documentation at https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
weiji14
commented
Aug 29, 2022
Member
Author
weiji14
left a comment
There was a problem hiding this comment.
Literally just translated the markdown template to a YAML template for now, let me know if there's anything to improve upon!
michaelgrund
approved these changes
Sep 8, 2022
weiji14
commented
Sep 8, 2022
maxrjones
approved these changes
Sep 14, 2022
Co-authored-by: Max Jones <meghanj@alum.mit.edu>
maxrjones
reviewed
Sep 14, 2022
Co-authored-by: Max Jones <meghanj@alum.mit.edu>
sixy6e
pushed a commit
to sixy6e/pygmt
that referenced
this pull request
Dec 21, 2022
…enericMappingTools#2091) A more structured and user friendly way of filling out bug reports. Syntax documentation at https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema * Give hints on how to provide a Minimal Complete Verifiable Example Adapted from https://github.com/pydata/xarray/blob/v2022.06.0/.github/ISSUE_TEMPLATE/bugreport.yml. * Instruct to provide OS, installation method and error message * Remove backslashes from pygmt.show_versions command Co-authored-by: Max Jones <meghanj@alum.mit.edu>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Description of proposed changes
A more structured and user friendly way of filling out bug reports.
Preview at https://github.com/GenericMappingTools/pygmt/blob/yaml-issue-form/.github/ISSUE_TEMPLATE/bug_report.yaml
Examples:
References:
Addresses #2050. Replaces the original markdown issue form added in e99e15f
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash commands are:
/format: automatically format and lint the code/test-gmt-dev: run full tests on the latest GMT development version