Create issue templates for PyBaseball project. #312
Conversation
Creating the template for PyBaseball project, initially we're just using some of the default options provided by Github.
Create issue templates for PyBaseball project.
There was a problem hiding this comment.
My personal ethos is that we should make it as easy as possible for people to submit an issue, and these have a tendency to add another hoop to jump through, so I'm not 100% sold on issue templates. However, if the community wants it, I'm happy to add it.
I think removing some of the redundancy as mentioned in the review so it's just very quick "tell me your problem and your setup" would help it feel less like a hurdle.
| **Expected behavior** | ||
| A clear and concise description of what you expected to happen. | ||
|
|
||
| **Screenshots** |
There was a problem hiding this comment.
I don't know about others but I personally dislike screenshots in issues. Would rather see the copy/pasted error message as-is.
| 3. Scroll down to '....' | ||
| 4. See error | ||
|
|
||
| **Expected behavior** |
There was a problem hiding this comment.
IMO I think the first three forms here are going to most often yield the same thing 3 times over and over: "I expected this to happen when I did this." I'd prefer one simpler form, something like
***Describe the bug and how to produce it***
| about: Create a report to help us improve | ||
| title: PYBASEBALL-BUG- | ||
| labels: '' | ||
| assignees: '' |
There was a problem hiding this comment.
I'd remove assignees. If things get assigned, I think that should be done by maintainers or whomever wants to do it, I'd rather not have the submitter choose who.
| **Desktop (please complete the following information):** | ||
| - OS: [e.g. Ubuntu, Windows] | ||
| - Python version [e.g. 3.7, 3.9] | ||
|
|
There was a problem hiding this comment.
Add:
- pybaseball version (e.g. 2.2.3, 2.2.4, or development if a direct clone)
I think this also motivates merging #295 to make this more accessible.
Creating the template for PyBaseball project,
initially we're just using some of the default options provided by Github.