search

SnowEx / snowexsql

A project to access the SnowEx database holding data from the NASA SnowEx campaign
https://snowexsql.readthedocs.io/en/latest/readme.html
GNU General Public License v3.0
23 stars 6 forks source link

GitHub - Add templates for feature and bug reports #90

Closed jomey closed 1 month ago

jomey commented 2 months ago

Edited the default template suggestions from GitHub

jomey commented 2 months ago

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 commented 2 months ago

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 commented 1 month ago

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.