Issue Templates

[alanvww]

I’ve been working on updating the issue template for this Github repo, and I’ve come up with some ideas and a structure that I think will make it easier for all contributors to report and discuss issues on our websites. Here are the ideas and structure I have so far:

1. Bug Report - Report a bug in the documentation
2. Documentation Improvement - Suggest an improvement to the documentation
3. Feature Request - Suggest a new feature for the documentation
4. Code Example Request - Request a new or improved code example
5. Typo/Grammar Correction - Report a typo or grammatical error
6. Broken Link Report
7. Accessibility Report

cc @MOQN and @QuinnHe

[shiffman]

Thank you @alanvww! @sharellb and I discussed issue templates for the ml5-next-gen repo a while back so it might be nice to synchronize these efforts!

[MOQN]

Thank you @alanvww for working on so many things so diligently! I believe This is a great start. While syncing up with the ml5-next-gen repo’s issue templates, as Dan suggested, we could consider some website-specific aspects. Please allow me to share some of my thoughts:

• Add Style/Design/Image Updates
• Add Compatibility (e.g., responsive layout features, functionalities based on OS and devices)
• Combine Typo/Grammar Correction, Broken Link Report, and Bug Report under a higher-level category (Update? Correction? Fix? Maintenance?). ("Bug Report" might be very rarely used in the Docsify repo.)

[sharellb]

Thanks @alanvww! here is a link to the github issue @shiffman mentioned above for issue templates in the ml5-next-gen repo. From the ideas and structure you have above the three that I think overlap between the repos are Bug Report, Feature Request, and Accessibility Report. Let's synchronize on the template structure/content between the docs and next gen repo? Also, I was thinking it would also be great to include some links to the documentation site in some of the github issue templates as a reference for contributors/question-askers/reports!

[alanvww]

@MOQN @sharellb Thanks for the great advice! Here is a more concise version:

1. Feature Request
2. Documentation Update
3. Compatibility & Accessibility
4. Maintenance Report

Feature Request

For new features or enhancements, this applies to ml5-next-gen and v02-gatsby as well. For instance, an idea could be to add a code examples gallery, which would be a feature for the website.

Fields

• Description
• Use case

Documentation Update

Covers content improvements, style/design changes, and code example requests

Fields

• Update type (Content/Style/Code Example)
• Description
• Proposed changes

Compatibility & Accessibility

For responsive design, cross-device functionality, and accessibility issues

Fields

• Issue type (Compatibility/Accessibility)
• Affected devices/users
• Current behavior
• Desired outcome

Maintenance Report

Combines bug reports, typos, broken links, and other minor fixes

Fields

• Issue type (Bug/Typo/Broken Link/Other)
• Location
• Description
• Suggested fix

---

For all templates, include:

• Clear title and brief explanation of when to use
• Relevant documentation links
• Reminder to check for existing issues
• Fields for screenshots/snippets and additional context where applicable

[MOQN]

Thank you @alanvww ! This looks fantastic to me. Why don't we use these templates and see what's missing and what could be improved?

[alanvww]

Thank you @alanvww ! This looks fantastic to me. Why don't we use these templates and see what's missing and what could be improved?

Sure! Let me implement it by Wednesday.

[alanvww]

@shiffman @MOQN @sharellb Templates added! And instead of the regular templates, I am using the new issue forms feature of Github, which allows the template to have dropdown and other features.

[alanvww]

@shiffman @MOQN @sharellb Based on the feedback I got from the meeting today, I found that there is external link support in the issue form!

[MOQN]

Thank you so much @alanvww !!!

[shiffman]

Wonderful, thank you @alanvww! What are the next steps to add these same templates/forms to the ml5-next-gen repo?

[alanvww]

Wonderful, thank you @alanvww! What are the next steps to add these same templates/forms to the ml5-next-gen repo?

I can make a quick PR to make these available in the `ml5-next-gen' repo! Maybe @sharellb can review the content first and give some feedback on how to make it more suitable for library issues?

[sharellb]

Thanks so much @alanvww and yes sounds great! I'll review the content and we can continue discussion in in the next-gen repo issusoe for you to make a PR from. In addition, if you'd like to pair together this week we can review together and add to the next-gen repo! :D