Skip to content

Commit

Permalink
chore: add issue & PR templates
Browse files Browse the repository at this point in the history
  • Loading branch information
kelly-sovacool committed Oct 11, 2023
1 parent f004a19 commit 462b46a
Show file tree
Hide file tree
Showing 4 changed files with 83 additions and 0 deletions.
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Bug report
description: Report something that is broken or incorrect
labels: bug
body:
- type: markdown
- type: textarea
id: description
attributes:
label: Description of the bug
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
id: reprex
attributes:
label: Code and output
description: Please include a minimal reproducible example (AKA a reprex). If you've never heard of a [reprex](http://reprex.tidyverse.org/) before, start by reading <https://www.tidyverse.org/help/#reprex>.
render: console
placeholder: |
library(reneeTools)
... insert_your_code_here() ...
Paste some output where something broke
- type: textarea
id: files
attributes:
label: Relevant files
description: |
Please drag and drop any relevant files here if applicable. Create a `.zip` archive if the extension is not allowed.
- type: textarea
id: system
attributes:
label: System information
description: |
* Version of R
* Version of CCBR/reneeTools
* OS _(eg. Ubuntu Linux, macOS)_
* Hardware _(eg. HPC, Desktop)_
4 changes: 4 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
contact_links:
- name: Discussions
url: https://github.com/CCBR/reneeTools/discussions
about: Please ask and answer questions here.
11 changes: 11 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: Feature request
description: Suggest an idea for the package
labels: enhancement
body:
- type: textarea
id: description
attributes:
label: Description of feature
description: Please describe your suggestion for a new feature. It might help to describe a problem or use case, plus any alternatives that you have considered.
validations:
required: true
27 changes: 27 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## Changes

<!--
Provide a summary of what is included in this Pull Request (PR).
-->

## Issues

<!--
Reference any issues related to this PR.
If this PR fixes any issues, [use a keyword](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)
when referring to the issue.
-->

<!--
**Reviewers**: Use the @ feature to mention anyone responsible for reviewing/completing this request.
-->

## PR Checklist

(~Strikethrough~ any points that are not applicable.)

- [ ] This comment contains a description of changes with justifications, with any relevant issues linked.
- ~[ ] Write unit tests for any new features, bug fixes, or other code changes.~ _testing framework not yet implemented_
- ~[ ] Update docs if there are any API changes.~ _on hold until before public release_
- [ ] If a new nextflow process is implemented, define the process `container` and `stub`.
- [ ] Update `CHANGELOG.md` with a short description of any user-facing changes and reference the PR number. Guidelines: https://keepachangelog.com/en/1.1.0/

0 comments on commit 462b46a

Please sign in to comment.