search

ml5js / ml5-next-gen

Repo for next generation of ml5.js: friendly machine learning for the web! 🤖
https://ml5js.org/
Other
72 stars 22 forks source link

Configure issue template for ml5-next-gen repo #168

Open sharellb opened 3 months ago

sharellb commented 3 months ago

Github allows the use of templates for issues we could use to make it easier to open an issue or provide more clear instructions. I'm thinking we could start with a simple all purpose issue template that we cross-like in contributing.md . In the future we could add more issue template types if needed for bugs vs features for example.

Some reference links: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository

https://github.com/stevemao/github-issue-templates?tab=readme-ov-file

shiffman commented 3 months ago

Hi @sharellb, yes, this sounds like a great plan! Excited to incorporate issue templates into the project!

sharellb commented 2 months ago

hi @shiffman! i'm trying to enable issue templates but checking if I'm running into a permissions issue. when you go to settings do you see a checkbox for enabling issues and are you able to check it? I believe it should look like the wiki and project sections. or if it's easier to update my repo access I can try again!

shiffman commented 2 months ago

Hi @sharellb, I checked and the settings actually involve more details for creating the templates themselves! I just upped your permissions so hopefully you can see it now to configure directly? Let me know! This is what I see:

Screenshot 2024-08-14 at 10 54 55 PM
sharellb commented 2 months ago

Updating my permissions worked and I see the button in your screenshot now, Thanks @shiffman!

sharellb commented 1 week ago

@alanvww has added Issue Template configurations to the ml5-webs-v02-docsify repo and we'd like to reuse as much between the issue templates as possible while updating the content to be relevant for the next-gen repo 🎉 Below are some of my thoughts on what we can update based off of the https://github.com/ml5js/ml5-website-v02-docsify/tree/main/.github/ISSUE_TEMPLATE:

General template updates:

template specifics: Bug & Maintenance report: This seems good to start with, maybe could also add the fields to add browser and operating system as that's good to know for debugging. Also relevant for next-gen repo could be coding environment (local vs p5 web editor etc) Compatibility & Accessibility Issues: This looks good to me to start with Feature Request: Would just update the About section to match enhancements for the library, maybe we could give examples of past features that have been added? Documentation Update: I think for the next-gen repo this could relate to updates for the ReadMe and maybe the p5 editor examples?

@alanvww let me know if there's any other feedback or content updates you think could apply here or if this is good to start with for making a pull request and thanks for the docs references! 💯