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

Create GitHub Issue Template #855

Closed
6 tasks
capnramses opened this issue Feb 16, 2024 · 1 comment · Fixed by #884
Closed
6 tasks

Create GitHub Issue Template #855

capnramses opened this issue Feb 16, 2024 · 1 comment · Fixed by #884
Assignees
Labels

Comments

@capnramses
Copy link
Collaborator

capnramses commented Feb 16, 2024

Why

Good descriptions on every GitHub Issue will help as we have a growing number of contributors.
See also #856 for PRs.

What

  • Bugs e.g. may be community-reported and require some details, and planned features, should have different templates if possible.
  • Why/What/Testing Done Coverage/Risks.
  • For bugs some form-filling would be nice e.g.
  • Version of Brevitas bug was found in = "x.y.z "
  • Expected result = "Halt on completion "
  • Observed result = "Caught fire "
  • Could you reproduce the buggy behaviour?
  • Bug reproduces only sometimes
  • Bug reproduces on every run
  • "Please provide a screenshot or text copy of the bug"
  • Please provide a list of steps/actions that can be taken to reproduce the bug.
@capnramses capnramses added the good first issue Good for newcomers label Feb 16, 2024
@capnramses capnramses self-assigned this Feb 16, 2024
@capnramses capnramses linked a pull request Feb 27, 2024 that will close this issue
@capnramses
Copy link
Collaborator Author

PR opened (linked). I used GH's template creator tool. It didn't seem to pull in my Feature Request template, just the Bug Report one, but I think that's okay to start with (bug report more important for info gathering).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant