Skip to content

Commit

Permalink
move templates from .github to here
Browse files Browse the repository at this point in the history
  • Loading branch information
Aariq committed Jun 20, 2022
1 parent 6cb910c commit e01501c
Show file tree
Hide file tree
Showing 6 changed files with 117 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.html
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/DEFAULT_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Issue Report
about: Report issues such as features not working, changing the way something works,
or enhancing a current feature.
title: Issue report
labels: 'bug'
assignees: ''

---

<!-- Fill out this issue by completing the items below. Not every item may be relevant to you, so feel free to make changes-->

**The current behavior or issue**
Description of the problem and why it's a problem

**The steps taken to reproduce the behavior or issue, or specify a location where the steps were recorded**
To reproduce:

For example:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Add other supporting information that may be useful**
Versions, OS information, other:

**Completion criteria**
This is done when:
- [ ] (replace this text)
- [ ] documentation updated
- [ ] tests written
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Documentation
about: Ticket for when documentation needs to be changed, updated, or added
title: Title of the documentation task
labels: documentation
assignees: ''

---

**Documentation Request Type**
<!-- For multiple requests, please submit one ticket per issue -->
Please choose one of the following:
- [ ] New documentation
- [ ] Documentation needs enhancement or clarification
- [ ] Documentation is broken, inaccurate, or out of date

**What needs to be done**
Please let us know your question, problem, or need.
What do you want to do, and what have you tried so far?
What specific parts of the documentation need to be clarified or extended?

**Result**
What's the result of doing this documentation task

<!--- Optional: specify what you would like the end results of this documentation task to be -->
**Desired Results**
- [ ] Result 1
- [ ] Result 2
- [ ] Result 3
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: I would like [...]
labels: enhancement
assignees: ''

---

**Please describe your request. Is your feature request related to a problem?**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen. Pro tip: don't propose any implementation details here, that's available below

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered. We don't mind if you haven't considered any

**Additional context**
Add any other context or screenshots about the feature request here. This is the place where you can suggest how you want this implemented. To be honest, we love to have your ideas, but may end up doing it differently
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/task.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Task
about: Ticket for when something needs to be done
title: Title of the task
labels: task
assignees: ''

---

**Task to do**
Overview of what needs to be done

**Reason**
Motivation for doing this task

**Result**
What's the result of doing this task

<!--- Optional -->

**Steps to take**
- [ ] None
- [ ] Step 1
- [ ] Step 2
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.Rproj.user
.Rhistory
.RData
.Ruserdata
*.Rproj

0 comments on commit e01501c

Please sign in to comment.