Skip to content

Commit

Permalink
chore: add github templates
Browse files Browse the repository at this point in the history
  • Loading branch information
tutkli committed Feb 23, 2024
1 parent a6f5efd commit 5f88601
Show file tree
Hide file tree
Showing 3 changed files with 115 additions and 0 deletions.
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/01-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Bug Report
description: Report a bug inside ngx-sonner
labels: [bug]

body:
- type: markdown
attributes:
value: |
Please search GitHub for a similar [issue](https://github.com/tutkli/ngx-sonner/issues) or [PR](https://github.com/tutkli/ngx-sonner/issues) before submitting a new issue.
- type: textarea
id: environment
attributes:
label: Please provide the environment you discovered this bug in.
description: Please create a minimal reproduction.
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
validations:
required: true

- type: textarea
id: exception-or-error
attributes:
label: Please provide the exception or error you saw
render: true

- type: textarea
id: other
attributes:
label: Other information

- type: checkboxes
id: assistance
attributes:
label: I would be willing to submit a PR to fix this issue
description: Assistance is provided if you need help submitting a pull request
options:
- label: 'Yes'
- label: 'No'
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/02-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Feature Request
description: Request a new or improved a feature in ngx-sonner
labels: [enhancement]

body:
- type: markdown
attributes:
value: |
Please search GitHub for a similar [issue](https://github.com/tutkli/ngx-sonner/issues) or [PR](https://github.com/tutkli/ngx-sonner/issues) before submitting a new issue.
- type: textarea
id: information
attributes:
label: Information
description: Tell us what you want to be added to ngx-sonner
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Describe any alternatives/workarounds you're currently using

- type: checkboxes
id: assistance
attributes:
label: I would be willing to submit a PR to fix this issue
description: Assistance is provided if you need help submitting a pull request
options:
- label: 'Yes'
- label: 'No'
40 changes: 40 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## PR Checklist

Please check if your PR fulfills the following requirements:

- [ ] The commit message follows our
guidelines: https://github.com/tutkli/ngx-sonner/blob/main/CONTRIBUTING.md#-commit-message-guidelines
- [ ] Tests for the changes have been added (for bug fixes / features)
- [ ] Docs have been added / updated (for bug fixes / features)

## PR Type

What kind of change does this PR introduce?

<!-- Please check the one that applies to this PR using "x". -->

- [ ] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, local variables)
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] CI related changes
- [ ] Documentation content changes
- [ ] Other... Please describe:

## What is the current behavior?

<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->

Closes #

## What is the new behavior?

## Does this PR introduce a breaking change?

- [ ] Yes
- [ ] No

<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->

## Other information

0 comments on commit 5f88601

Please sign in to comment.