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 bug report issue template #157

Merged
merged 2 commits into from
Mar 13, 2024

Conversation

sjspielman
Copy link
Member

Purpose

This PR adds a bug report issue template.

Issue Addressed

Closes #29

Any comments, concerns, or questions important for reviewers

Let me know what you think about section headers as well as guiding comments!

Copy link
Member

@jaclyn-taroni jaclyn-taroni left a comment

Choose a reason for hiding this comment

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

Content looks good. Putting the descriptions in the HTML comment, rather than italics, could be a point of confusion if you are not used to writing in Markdown. I say you file a ticket to evaluate that practice holistically before launch.

@sjspielman
Copy link
Member Author

sjspielman commented Mar 13, 2024

Content looks good. Putting the descriptions in the HTML comment, rather than italics, could be a point of confusion if you are not used to writing in Markdown. I say you file a ticket to evaluate that practice holistically before launch.

I filed an issue for that here #164!

One thought I have on this - we plan to include some docs about using markdown (see #36). Maybe it would be helpful to actually include at the top of each issue template something like:

Welcome to the issue template! It's written in markdown <link to markdown docs>. HTML comments give instructions for how to fill this out. You can click the "Preview" button anytime to see how this renders. Learn more about issues in OpenScPCA <from these docs about issues>.

@sjspielman sjspielman merged commit 919a058 into main Mar 13, 2024
3 checks passed
@sjspielman sjspielman deleted the sjspielman/29-bug-report-issue-template branch March 13, 2024 13:43
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.

Create a bug report issue template
2 participants