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

[toggle-core] Update issue template for bugs using new issue form in a YAML file #299

Closed
xserrat opened this issue Oct 2, 2021 · 5 comments
Labels
epic Hacktoberfest HacktoberFest related issues

Comments

@xserrat
Copy link
Collaborator

xserrat commented Oct 2, 2021

In order to make easier the creation of bugs following a specific format, we should update the markdown file into a YAML file.

See Github Docs.

This epic contains:

@xserrat xserrat added epic Hacktoberfest HacktoberFest related issues labels Oct 2, 2021
This was referenced Oct 2, 2021
@kpicaza kpicaza added this to To do in Kanvan Board Oct 2, 2021
@pcs289
Copy link
Member

pcs289 commented Oct 2, 2021

How about using this bug_report YAML file found at toggle-ui PR#3 to have all ISSUE_TEMPLATES standardized? Otherwise, do you think we should customize bug_report templates on a per-repo basis?

@xserrat
Copy link
Collaborator Author

xserrat commented Oct 3, 2021

Ouch! I didn't see your comment. I've just merged the first issue regarding this epic and I named the file as bug.yml directly. What do you think? See https://github.com/pheature-flags/pheature-flags/blob/1.0.x/.github/ISSUE_TEMPLATE/bug.yml . We could use a similar structure.

Regarding the customisation, I agree with you that we could customise them. For the issue #300 that it was a bug report for the pheature-flags repo, I've added a section called Integration with a dropdown of the three possible integrations: Standalone, Symfony, Mezzio and Laravel. I think that for Toggle UI we could set a dropdown for each component maybe... @kpicaza what do you think about that?

@xserrat
Copy link
Collaborator Author

xserrat commented Oct 3, 2021

@pcs289 , check also the https://github.com/pheature-flags/pheature-flags/blob/1.0.x/.github/ISSUE_TEMPLATE/bug.yml. I've set the two suggested labels bug and triage. The triage is added in order to help maintainers to filter by those issues pending to check by maintainers. I think that it's a good way to keep control about incoming bugs. After checking the bug and ensure that it's a real bug, we can remove the triage label to mark as "real bug". What do you think?

@pcs289
Copy link
Member

pcs289 commented Oct 3, 2021

@xserrat I am using the template at PR#3 for toggle-ui as the Integration dropdown is not needed.

@pcs289
Copy link
Member

pcs289 commented Dec 27, 2021

🚀

@pcs289 pcs289 closed this as completed Dec 27, 2021
Kanvan Board automation moved this from To do to Done Dec 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
epic Hacktoberfest HacktoberFest related issues
Projects
Development

No branches or pull requests

2 participants