Open PierrickGT opened 4 years ago
In the light of curator program it seems that there are lots of issues being created and team will have hard time to go through them. AnnaV#1421 did a great job in organizing prior issues. But I think we have to make it easier for the team to work on all upcoming issues created by community while simultaneously bringing more information and clarity into issues. Therefore I propose implementing such issue templates for the start (we can add more categories later, if we need):
Suggestion Bug report
Provide detailed description of your idea how to improve Everest so it would be as easy as possible for team to implement your ideas/features
If it's necessary, please add graphics that represent your idea as clear as possible.
how Bug report template would look like:
Please provide a detailed description of the bug you encountered and list the steps that are required to reproduce similar behavior. What is expected interface behavior in this particular case?
Please provide information on the system and browser you're using that you reckon will be helpful to resolve the bug
If you reckon it will help to resolve the issue, please add the necessary screenshots of the bug you encountered.
This might be a small but very effective step in organizing upcoming issues, some of ideas here were inspired by Keep network issues templates, which I had a pleasant experience working with
https://docs.github.com/en/free-pro-team@latest/github/building-a-strong-community/about-issue-and-pull-request-templates Quick link for implementation guide (but i guess team already knows how to do that)
Here is a link to the spreadsheet @saltypalo has mentionned: https://docs.google.com/spreadsheets/d/1Wr3WXUNUnA05pxEEnFZp3rQ0C4QSrElVKgbKBVlU-JY
Great work by AnnaV#1421 on Discord! It will really help us organize things on this repo.
Great suggestions for the issue templates @saltypalo!
I think for the bug report one we could start with this one: https://github.com/stevemao/github-issue-templates/blob/master/simple/ISSUE_TEMPLATE.md
Add the Screenshots
section as you proposed and also a sentence reminding people to search first before posting an issue.
A sentence like this one: Your issue may already be reported! Please search on the issue tracker before creating one.
About the Suggestion
template, maybe we should call it Feature request
?
Suggestion
sounds kinda vague to me and we could use the enhancement
label that already exists on this repo.
Instead of asking people to only write a description of the feature they would like to see implemented, maybe we should first ask them if this feature is related to a problem they've encountered.
Something like: Is your feature request related to a problem? Please describe the problem you are trying to solve.
And then ask them to provide a solution: Describe the solution you'd like. Please describe the feature you would like to see implemented.
We can keep the Images
section for people that would like to share some sketches explaining their solution.
Let me know what you think. :)
I agree with most of the point you outlined @PierrickGT
So far it doesn't seem any third category besides Bug report and Suggestion/Feature request is needed. After team reviews issues they would add some more labels like Triage or subcategories for features, eg Design feature, Backend etc etc.
We are currently at 216 issues and 12 Pull Requests after only a week. It is obvious that the current system isn't working and that we need some kind of safe guard to categorize issues.
I propose that we add issue templates, a good place to start would be the following repository: https://github.com/stevemao/github-issue-templates/
We can also add labels to easily find the categorized issues.
The next step would be to order issues by order of priority, but I don't think we can really do this without a better system to categorize issues first.