Added github "issue templates" for bug reports and new feature requests

ErykKul · Sep 19, 2021 · 1dc9242 · 1dc9242
1 parent 4323ced
commit 1dc9242
Show file tree

Hide file tree

Showing 4 changed files with 102 additions and 3 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,62 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+<!--
+Thank you for contributing to the Dataverse Project!
+
+NOTE: Make sure you search the issue tracker to verify this bug has not been submitted already.
+
+Issue tracker: https://github.com/IQSS/dataverse/issues
+
+If there is an existing open issue that matches the issue you want to report, please add a comment to it.
+
+If there is no pre-existing issue or it has been closed, please proceed with creating this bug issue.
+
+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 does it occurs on?
+
+
+* What happens?
+
+
+* To whom does it occur (anonymous visitor, editor, administrator)?
+
+
+* 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
+*
+Or you can drag and drop your file to this comment directly
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,40 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: 'Feature Request/Idea:'
+labels: ''
+assignees: ''
+
+---
+<!--
+Thank you for contributing to the Dataverse Project!
+
+Your idea or feature request might already be captured in the Dataverse issue tracker on GitHub but if not, the best way to bring it to the community's attention is by posting on the [dataverse-community Google Group](https://groups.google.com/group/dataverse-community) or bringing it up on a [Community Call](https://dataverse.org/community-calls). You're also welcome to make some noise in chat.dataverse.org or cram your idea into 280 characters and mention @dataverseorg on Twitter. To discuss your idea privately, please email it to support@dataverse.org
+
+There's a chance your idea is already on our roadmap, which is available at https://www.iq.harvard.edu/roadmap-dataverse-project
+Issue tracker: https://github.com/IQSS/dataverse/issues
+
+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 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?**
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -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!

diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md