Skip to content

Commit

Permalink
Merge pull request #8101 from ysuarez/issue_templates_work
Browse files Browse the repository at this point in the history
Added github "issue templates" for bug reports and new feature requests
  • Loading branch information
kcondon authored Oct 5, 2021
2 parents 59869a6 + 01de8d9 commit 4b1487a
Show file tree
Hide file tree
Showing 4 changed files with 88 additions and 3 deletions.
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
---
name: Bug report
about: Did you encounter something unexpected or incorrect in the Dataverse software? We'd like to hear about it!
title: ''
labels: ''
assignees: ''

---
<!--
Thank you for contributing to the Dataverse Project through the creation of a bug report!
WARNING: If this is a security issue it should be reported privately to security@dataverse.org
More information on bug issues and contributions can be found in the "Contributing to Dataverse" page:
https://github.com/IQSS/dataverse/blob/develop/CONTRIBUTING.md#bug-reportsissues
Please fill out as much of the template as you can.
Start below this comment section.
-->
**What steps does it take to reproduce the issue?**

* When does this issue occur?


* Which page(s) does it occurs on?


* What happens?


* To whom does it occur (all users, curators, superusers)?


* What did you expect to happen?



**Which version of Dataverse are you using?**



**Any related open or closed issues to this bug report?**



**Screenshots:**

No matter the issue, screenshots are always welcome.

To add a screenshot, please use one of the following formats and/or methods described here:

* https://help.github.com/en/articles/file-attachments-on-issues-and-pull-requests
*
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Feature request
about: Suggest an idea or new feature for the Dataverse software!
title: 'Feature Request/Idea:'
labels: ''
assignees: ''

---
<!--
Thank you for contributing to the Dataverse Project through the creation of a feature request!
More information on ideas/feature requests and contributions can be found in the "Contributing to Dataverse" page:
https://github.com/IQSS/dataverse/blob/develop/CONTRIBUTING.md#ideasfeature-requests
Please fill out as much of the template as you can.
Start below this comment section.
-->

**Overview of the Feature Request**


**What kind of user is the feature intended for?**
(Example users roles: API User, Curator, Depositor, Guest, Superuser, Sysadmin)


**What inspired the request?**


**What existing behavior do you want changed?**


**Any brand new behavior do you want to add to Dataverse?**


**Any related open or closed issues to this feature request?**
2 changes: 0 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,6 @@ If there is no pre-existing issue or it has been closed, please click on the "Ne

If you do not receive a reply to your new issue or comment in a timely manner, please email support@dataverse.org with a link to the issue.

We are aware of the new issue templates described at https://help.github.com/articles/about-issue-and-pull-request-templates but haven't converted over yet.

### Writing an Issue

For the subject of an issue, please start it by writing the feature or functionality it relates to, i.e. "Create Account:..." or "Dataset Page:...". In the body of the issue, please outline the issue you are reporting with as much detail as possible. In order for the Dataverse development team to best respond to the issue, we need as much information about the issue as you can provide. Include steps to reproduce bugs. Indicate which version you're using, which is shown at the bottom of the page. We love screenshots!
Expand Down
1 change: 0 additions & 1 deletion ISSUE_TEMPLATE.md

This file was deleted.

0 comments on commit 4b1487a

Please sign in to comment.