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

Added a feature for bug reporting #72

Merged
merged 7 commits into from
Oct 2, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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!
Copy link
Collaborator

Choose a reason for hiding this comment

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

More of a note to myself: we should include a warning like "This report will be public. Do not include confidential research data in this report. This information might be in file names, transcripts, and some log outputs so double check before you submit!"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I did not change anything here. If you want, we can add this disclaimer also into the 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
11 changes: 11 additions & 0 deletions Documents.code-workspace
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"folders": [
{
"path": "../../.."
},
{
"path": "../.."
}
],
"settings": {}
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is this a config file from VS Code? I don't think you meant to commit this. You can add *.code-workspace to your .gitignore so that git commit -a ignores files like this.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you!
I added it to the .gitignore and pushed it again. I hope, it works now.
Sorry for the inconvenience

Copy link
Collaborator

Choose a reason for hiding this comment

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

No inconvenience, it's why we do code review!

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