From 5f88601cd77454b69ed697392cd60a8f5a798168 Mon Sep 17 00:00:00 2001 From: Clara Castillo Date: Fri, 23 Feb 2024 11:03:04 +0100 Subject: [PATCH] chore: add github templates --- .github/ISSUE_TEMPLATE/01-bug-report.yml | 44 +++++++++++++++++++ .github/ISSUE_TEMPLATE/02-feature-request.yml | 31 +++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 40 +++++++++++++++++ 3 files changed, 115 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/01-bug-report.yml create mode 100644 .github/ISSUE_TEMPLATE/02-feature-request.yml create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/01-bug-report.yml b/.github/ISSUE_TEMPLATE/01-bug-report.yml new file mode 100644 index 0000000..2dd07ac --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug-report.yml @@ -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' diff --git a/.github/ISSUE_TEMPLATE/02-feature-request.yml b/.github/ISSUE_TEMPLATE/02-feature-request.yml new file mode 100644 index 0000000..1118dc4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-feature-request.yml @@ -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' diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..06331aa --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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? + + + +- [ ] 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? + + + +Closes # + +## What is the new behavior? + +## Does this PR introduce a breaking change? + +- [ ] Yes +- [ ] No + + + +## Other information