Skip to content

Add templates for issues#1588

Merged
anautsch merged 12 commits intospeechbrain:developfrom
Adel-Moumen:issue-template
Oct 11, 2022
Merged

Add templates for issues#1588
anautsch merged 12 commits intospeechbrain:developfrom
Adel-Moumen:issue-template

Conversation

@Adel-Moumen
Copy link
Copy Markdown
Collaborator

@Adel-Moumen Adel-Moumen commented Sep 29, 2022

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:
Screenshot 2022-09-29 at 17 42 51

I drop here some screenshots of the templates:

Home when you are opening an issue.
Screenshot 2022-09-29 at 17 37 55

Issue template.
Screenshot 2022-09-29 at 17 39 05

Feature request template.
Screenshot 2022-09-29 at 17 39 35

@Adel-Moumen Adel-Moumen added the enhancement New feature or request label Sep 29, 2022
Copy link
Copy Markdown
Collaborator

@pplantinga pplantinga left a comment

Choose a reason for hiding this comment

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

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".

Comment thread .github/ISSUE_TEMPLATE/feature_request.yaml Outdated
Comment thread .github/ISSUE_TEMPLATE/bug_report.yaml Outdated
Co-authored-by: Peter Plantinga <plantinga.peter@protonmail.com>
@Adel-Moumen
Copy link
Copy Markdown
Collaborator Author

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".

Yes, as shown on top, we can bind a discussion link similarly to how "feature request" / "bug report" is displayed. I'll do it.

@Adel-Moumen
Copy link
Copy Markdown
Collaborator Author

So, I added the link to Discussions directly in the issues template "home":

Screenshot 2022-10-06 at 11 04 30

So now users can directly know where to put questions 🙂

@Adel-Moumen Adel-Moumen requested a review from pplantinga October 6, 2022 10:42
Copy link
Copy Markdown
Collaborator

@pplantinga pplantinga left a comment

Choose a reason for hiding this comment

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

I looked it over, LGTM!

@anautsch anautsch merged commit 64c8fa9 into speechbrain:develop Oct 11, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants