Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add GitHub Issue template #442

Merged
merged 4 commits into from
Feb 20, 2024
Merged

Add GitHub Issue template #442

merged 4 commits into from
Feb 20, 2024

Conversation

lukestanley
Copy link
Member

@lukestanley lukestanley commented Jan 30, 2024

Adds a template to help ensure we capture key details so we can reproduce them, know how important problems are, and so on.

Copy link

vercel bot commented Jan 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
kendraio-app ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 6, 2024 9:55am

Copy link
Collaborator

@gsambrotta gsambrotta left a comment

Choose a reason for hiding this comment

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

👏 Looks great to me!

@dahacouk
Copy link
Member

@lukestanley is this a form that developers will fill in? Is it clear how they will compose the issue? And what text is helper text that will be removed when the issue is published? Is it clear what should not be included in the published issue? So, for example, rather than "Describe the bug" should it be "Bug description"? I guess I'm asking you to consider the developer experience of how they answer the questions to make it easier and quicker to answer the questions. And also what the resultant issue will look like to make it easier to read. Makes sense?

@dahacouk
Copy link
Member

For example, this random issue I found by Googling, has helper text clearly marked. Am I missing something here?

@lukestanley
Copy link
Member Author

For example, this random issue I found by Googling, has helper text clearly marked. Am I missing something here?

Cool, I don't think you're missing something, I didn't realise that "comment block" syntax was supported! I've now updated the suggested issue template that now uses it. I used the template for a real issue, here: #444

@dahacouk
Copy link
Member

dahacouk commented Feb 5, 2024

Cool @lukestanley. I know I'm nit-picking but how about removing the colons from the headings and being consistent? It helps nothing but promote the practice of being consistent – which we should all aspire to. Cheers!

@lukestanley lukestanley merged commit 34c4fc5 into develop Feb 20, 2024
3 checks passed
@gsambrotta gsambrotta deleted the issue-template branch May 15, 2024 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants