Add templates for issues#1588
Merged
anautsch merged 12 commits intospeechbrain:developfrom Oct 11, 2022
Merged
Conversation
pplantinga
approved these changes
Oct 6, 2022
Collaborator
pplantinga
left a comment
There was a problem hiding this comment.
Looks pretty good to me. As we discussed offline, perhaps there should be a clear way to direct users to the discussion board if they have a question or topic that isn't necessarily one of "bug report" or "feature request".
Co-authored-by: Peter Plantinga <plantinga.peter@protonmail.com>
Collaborator
Author
Yes, as shown on top, we can bind a discussion link similarly to how "feature request" / "bug report" is displayed. I'll do it. |
Collaborator
Author
pplantinga
approved these changes
Oct 6, 2022
Collaborator
pplantinga
left a comment
There was a problem hiding this comment.
I looked it over, LGTM!
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
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.

Hello,
This PR aims at adding templates for better workflow management of issues.
As a side note, for the issues template, we will need to develop a python script that will fetch the information that we need. This is not mandatory, and we will need to have a discussion on that to clearly identify what we need (e.g OS system, speechbrain version....).
Furthermore, I propose to replace our Discourse (which is no longer maintained) with the official GitHub feature "Discussion" (see: https://docs.github.com/en/discussions). The idea would be to gather there all the questions (e.g how to do X with speechbrain?), but also important notes (e.g PhD positions) / current development of Speechbrain for better communication with our users 🔥. This would be simpler to use, and this is already available freely with GitHub.
We can also bind it to our "home issues template" similarly to how Coqui-TTS did it:

I drop here some screenshots of the templates:
Home when you are opening an issue.

Issue template.

Feature request template.
