Skip to content

Commit

Permalink
add Issue and PR templates (#554)
Browse files Browse the repository at this point in the history
  • Loading branch information
sbfnk authored Feb 19, 2024
1 parent 50fc3cf commit d4b5f41
Show file tree
Hide file tree
Showing 5 changed files with 114 additions and 0 deletions.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Bug report
about: |
*Bugs* manifest in issue when using the package but may also include behaviour
that does not impact package functionality, but which seems as though it might
not be intended by the package developers.
title: ''
labels: ''
assignees: ''
---

<!-- Thank you for reporting a bug. Please use the section headers below
for providing more detail where appropriate -->

Summary:
Please provide a short summary (no more than a sentence or two).

Description:
Describe the issue as clearly as possible.

Reproducible Steps:
Please report steps to reproduce the issue. If it's not possible to reproduce, please include a description of how you discovered the issue.

If you can produce a [reproducible example](http://reprex.tidyverse.org/articles/reprex-dos-and-donts.html), please include it.

EpiNow2 Version:
The version of EpiNow2 you are running (e.g., from `packageVersion("EpiNow2")`)

---------

23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Documentation
about: |
Documentation issues could be typos, unclear descriptions, issues with
existing vignettes, or suggestions for a new vignette.
title: ''
labels: ''
assignees: ''
---

<!-- Thank you for helping improve our documentation. Please use the section
headers below for providing more detail where appropriate -->

Type of issue:
State whether you are commenting on existing documentation / vignettes, or suggesting a new vignette.

Detail:
Provide any detail that may be useful for discussion.

---------



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 suggestion
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---

<!-- Thank you for suggesting a feature. Please use the section headers below
for providing more detail where appropriate -->

Is your feature request related to a problem? Please describe:
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.

Additional context:
Add any other context or screenshots about the feature request here.ocument Title

10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/other_issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Other issue
about: Any issue that doesn't fit the other categories
title: ''
labels: ''
assignees: ''
---

Please include a brief description of the issue and any proposed solutions you may have.

31 changes: 31 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<!-- Thanks for opening this Pull Request! Below we have provided a suggested
template for PRs to this repository and a checklist to complete before
opening a PR -->

<!-- If this is your first Pull Request, please make sure you read the
contributing guidelines linked below and at
https://github.com/epiforecasts/EpiNow2/blob/main/.github/CONTRIBUTING.md -->

## Description

This PR closes #<issue-number>.

<!-- Add any additional context for or description of the changes that you made in this pull request. -->

## Initial submission checklist

<!-- This is for guidance only - please feel free to ignore any lines that don't apply -->

- [ ] My PR is based on a package issue and I have explicitly linked it.
- [ ] I have tested my changes locally (using `devtools::test()` and `devtools::check()`).
- [ ] I have added or updated unit tests where necessary.
- [ ] I have updated the documentation if required and rebuilt docs if yes (using `devtools::document()`).
- [ ] I have followed the established coding standards (and checked using `lintr::lint_package()`).
- [ ] I have added a news item linked to this PR.

## After the initial Pull Request

- [ ] I have reviewed Checks for this PR and addressed any issues as far as I am able.

<!-- Thanks again for this PR - @EpiNow2 dev team -->

0 comments on commit d4b5f41

Please sign in to comment.