Skip to content

Commit

Permalink
chore: add github issue and pull request templates
Browse files Browse the repository at this point in the history
  • Loading branch information
angeloashmore committed Nov 3, 2021
1 parent 0d2c3b3 commit 25f2d4f
Show file tree
Hide file tree
Showing 4 changed files with 94 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,37 @@
---
name: 🚨 Bug report
about: Report a bug report to help improve the package.
title: ""
labels: "bug"
assignees: ""
---

<!-- 💙 Thanks for your time to make this package better with your feedback 💙
**IMPORTANT** Before reporting a bug please make sure that you have read through the documentation:
- https://prismic.io/docs
👍 A properly detailed bug report can save a LOT of time and help fixing issues as soon as possible.
-->

### Versions

- @prismicio/react: <!-- ex: v0.1.0 -->
- react: <!-- ex: v17.0.0 -->
- node: <!-- ex: v12.14.0 -->

### Reproduction

<!-- If possible link to a minimal test case, without a reproduction, it is so hard to address problems :( -->

<details open>
<summary>Additional Details</summary>
<br>
<!-- Attaching `package.json`, dependencies, logs or code snippets would help to find the issue -->
</details>

### Steps to reproduce

### What is expected?

### What is actually happening?
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: 👪 Prismic Community Forum
url: https://community.prismic.io
about: Ask a question about the package or raise an issue directly related to Prismic. You will usually get support there more quickly!
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,25 @@
---
name: 🙋‍♀️ Feature request
about: Suggest an idea or enhancement for the package.
title: ""
labels: "enhancement"
assignees: ""
---

<!-- 💙 Thanks for your time to make this package better with your feedback 💙 -->

### 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. Adding some code examples would be neat! -->

### Describe alternatives you've considered

<!-- A clear and concise description of any alternative solutions or features you've considered. -->

### Additional context

<!-- Add any other context or screenshots about the feature request here. -->
27 changes: 27 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,27 @@
<!--- Provide a general summary of your changes in the title above -->

## Types of changes

<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->

- [ ] Chore (a non-breaking change which is related to package maintenance)
- [ ] Bug fix (a non-breaking change which fixes an issue)
- [ ] New feature (a non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

## Description

<!--- Describe your changes in detail -->
<!--- Why is this change required? What problem does it solve? -->
<!--- If it resolves an open issue, please link to the issue here. For example "Resolves: #137" -->

## Checklist:

<!--- Put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

- [ ] My change requires an update to the official documentation.
- [ ] All [TSDoc](https://tsdoc.org) comments are up-to-date and new ones have been added where necessary.
- [ ] All new and existing tests are passing.

<!--- A cute animal (or car) picture is welcome to close your PR! -->

0 comments on commit 25f2d4f

Please sign in to comment.