Skip to content

Commit

Permalink
Add bug reporting form and README update
Browse files Browse the repository at this point in the history
Completes a subtask of #70.
Squashed commit of PR #72 by DerMoehre
  • Loading branch information
DerMoehre authored Oct 2, 2022
1 parent 6090004 commit 3ff4da7
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Bug Report
description: The software does something unwanted or unusual
title: "[BUG]: "
labels: ["bug"]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes
id: new-bug
attributes:
label: Did you search for similar bugs?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: false
- type: textarea
id: bug-description
attributes:
label: What happened?
description: Tell us what bug you encountered
validations:
required: true
- type: textarea
id: bug-behaviour
attributes:
label: Expectations?
description: Tell us what should have happened
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps To Reproduce
description: Can you describe your steps, when you encountered the bug?
placeholder: Please write the steps in a list form
validations:
required: false
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
*.wav
build/*
docs/_build
*.code-workspace
*.swp
*.orig
env
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ You can find user support for installing and using the FAVE toolkits at the [FAV
## Contributing to FAVE
For the most part, we'll be utilizing the fork-and-pull paradigm (see [Using Pull Requests](https://help.github.com/articles/using-pull-requests)). Please send pull requests to the `dev` branch.

You can fill in a bug report at the [issue tab](https://github.com/JoFrhwld/FAVE/issues)

There may be a delay between when a bug is reported and when a bug is resolved. Developers prioritize bugs based on difficulty, importance, and other factors, so bug reports are usually not handled in the order they are received.

## Attribution
[![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.22281.svg)](http://dx.doi.org/10.5281/zenodo.22281)
As of v1.1.3 onwards, releases from this repository will have a DOI associated with them through Zenodo. The DOI for the current release is [10.5281/zenodo.22281](http://dx.doi.org/10.5281/zenodo.22281). We would recommend the citation:
Expand Down

0 comments on commit 3ff4da7

Please sign in to comment.