Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new issue and PR templates #197

Merged
merged 2 commits into from
Apr 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/01-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Bug Report
description: File a bug report.
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: checkboxes
id: terms
attributes:
label: Confirm setup
description: By submitting this issue, you confirm to have done the following in preparation:
options:
- label: I have installed the development version of `{gptstudio}` (`pak::pak("MichelNivard/gptstudio")`) and tested if the problem remains.
required: true
- label: I have installed the `{reprex}` and `{sessioninfo}` packages to be able to run this issue's code snippet `pak::pak(c("reprex", "sessioninfo"))`.
required: true
- type: textarea
id: problem
attributes:
label: What happened?
description: |
Also tell us, what did you expect to happen? Be as verbose as possible.

Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
placeholder: Tell us what you see!
value: "I was trying to do X, and when I typed/clicked Y, I found the following problem:"
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
render: shell
- type: textarea
id: sessioninfo
attributes:
label: Session info
description: Please run `reprex::reprex(gptstudio::gptstudio_sitrep(), session_info = TRUE)` and paste the output here. It will provides us more context on your system.
render: r
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/MichelNivard/gptstudio?tab=coc-ov-file#).
options:
- label: I agree to follow this project's Code of Conduct
required: true
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/02-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Feature request
description: Make a case for a new feature.
title: "[FR]: "
labels: ["feature"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this form!
- type: textarea
id: case
attributes:
label: What would you like to have?
description: |
Be as verbose as possible. You can use examples from other projects.

Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
placeholder: Let us know your thoughts!
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/MichelNivard/gptstudio?tab=coc-ov-file#).
options:
- label: I agree to follow this project's Code of Conduct
required: true
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
14 changes: 0 additions & 14 deletions .github/ISSUE_TEMPLATE/issue_template.md

This file was deleted.

19 changes: 19 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
## Related issue

- Closes #XX

## Description of changes

-

## For contributors

- [] I have added the relevant changes to the NEWS.md file
- [] I have added relevant tests or documentation with my changes

## For reviewers

- [] Changes meet the acceptance criteria of the related issue
- [] The contribution follows style conventions and code of conduct
- [] Branch passes automated testing
- [] I have incremented the package version in the DESCRIPTION file before merging
Loading