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.

Sign up for GitHub

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

Jump to bottom

Added YAML templates of bug reports and feature requests #34

Merged
merged 8 commits into from
Aug 18, 2022
Merged

Added YAML templates of bug reports and feature requests #34

merged 8 commits into from
Aug 18, 2022

Conversation

M-casado
Copy link
Collaborator

Description

  • Added a YAML template for:
    • Bug report
    • Feature request
  • Removed the existing MD templates

Motivation and Context

YAML templates allow for constraints and look nicer over all (better UI).

How has this been tested?

Has not been tested but the place that I took inspiration from (our own metadata repo) was tested.

What should reviewers focus on?

  • That the grammar is correct and there are no typos
  • If there are redundant or missing fields and unnecessary constraints.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New content (non-breaking change which adds new content)
  • Modified content (non-breaking change which modifies existing content)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • I have read the CONTRIBUTING.md guide.
  • My changes follow the code style of this project.
  • I have updated supporting documentation, if required.
  • I have added my details to the CONTRIBUTORS.yaml file.

@M-casado M-casado added the documentation Improvements or additions to documentation label Aug 18, 2022
@M-casado M-casado self-assigned this Aug 18, 2022
malloryfreeberg
malloryfreeberg suggested changes Aug 18, 2022
View reviewed changes
Copy link
Contributor

@malloryfreeberg malloryfreeberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Useful changes!

Made a few wording suggestions. Haven't tested the new templates but I think I can't test until they are merged?

@malloryfreeberg malloryfreeberg linked an issue Aug 18, 2022 that may be closed by this pull request
[Feature] YAML issue templates #28
Closed
M-casado and others added 7 commits August 18, 2022 14:44
@M-casado
Copy link
Collaborator Author

Merged your suggestions, @malloryfreeberg. Indeed, they cannot be tested till merged. Unless I forked the files. But I expect them to work since I didn't change the syntax. If there's an issue it can be quickly fixed 👍

@malloryfreeberg malloryfreeberg self-requested a review August 18, 2022 13:56
malloryfreeberg
malloryfreeberg approved these changes Aug 18, 2022
View reviewed changes
Copy link
Contributor

@malloryfreeberg malloryfreeberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@malloryfreeberg malloryfreeberg merged commit fad13dc into main Aug 18, 2022
@malloryfreeberg malloryfreeberg deleted the issues_yaml_template branch August 18, 2022 13:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@malloryfreeberg malloryfreeberg malloryfreeberg approved these changes

Assignees

@M-casado M-casado

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Feature] YAML issue templates
2 participants
@M-casado @malloryfreeberg