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

GitHub - Add templates for feature and bug reports #90

Merged
merged 1 commit into from
Jul 15, 2024

Conversation

jomey
Copy link
Member

@jomey jomey commented Jul 11, 2024

Edited the default template suggestions from GitHub

@jomey jomey requested a review from a team July 11, 2024 23:02
Copy link
Contributor

@aaarendt aaarendt left a comment

Choose a reason for hiding this comment

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

I'm looking at this example bug report and they include space for a screenshot. Should we include that too?

@jomey
Copy link
Member Author

jomey commented Jul 12, 2024

I'm looking at this example bug report and they include space for a screenshot. Should we include that too?

This looks like the template that GitHub also first suggest when you start this process. I removed the sections for screenshots as I have personally never found them very useful. A copy of the actual code that causes it and the stracktrace has been most useful.

We could add some lines to encourage attaching a notebook.

Thoughts?

@aaarendt
Copy link
Contributor

Sounds good, I trust your greater experience on this one. I'd say no to the notebook? Seems like the bug report forces people to be concise, whereas a notebook might promote dumping more code than is relevant to the problem?

@jomey
Copy link
Member Author

jomey commented Jul 15, 2024

I'd say no to the notebook? Seems like the bug report forces people to be concise, whereas a notebook might promote dumping more code than is relevant to the problem?

Good point. Let's start with this and we can always revisit.

Copy link
Contributor

@micah-prime micah-prime left a comment

Choose a reason for hiding this comment

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

This looks great!

@jomey jomey merged commit f3d8964 into master Jul 15, 2024
10 checks passed
@jomey jomey deleted the Bug-featre-templates branch July 15, 2024 19: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.

3 participants