Skip to content

Commit

Permalink
chore: Reword issue template
Browse files Browse the repository at this point in the history
- Move context up top
- Add disclaimer about following the template
  • Loading branch information
franky47 committed Nov 11, 2023
1 parent a2fff13 commit 7c556ee
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 16 deletions.
39 changes: 23 additions & 16 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,29 @@ labels: bug
assignees: ''
---

<!-- Please read and follow the issue template. Issues submitted without a reproduction and context will take longer to resolve. -->

## Context

What's your version of `next-usequerystate`?

```
-> Paste result from `cat package.json | grep next-usequerystate` here
```

Next.js information (obtained by running `next info`):

```
-> Paste result from `next info` here
```

Does this concern:

<!-- Replace the space with an x between the square brackets to tick the relevant box(es) -->

- [ ] The app router
- [ ] The pages router

## Description

<!-- A clear and concise description of what the bug is. -->
Expand All @@ -26,19 +49,3 @@ Example: Steps to reproduce the behavior:
## Expected behavior

<!-- A clear and concise description of what you expected to happen, and what happened instead. -->

## Context

What's your version of `next-usequerystate`?

```
-> Paste result from `cat package.json | grep next-usequerystate` here
```

Next.js information (obtained by running `next info`):

```
-> Paste result from `next info` here
```

<!-- Anything else to add? -->
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,13 @@ run the end-to-end tests against the test bench Next.js app (which uses the buil
When proposing changes or showcasing a bug, adding a minimal reproduction in the
playground can be very helpful.

## Opening issues

Please follow the [issue template](.github/ISSUE_TEMPLATE/bug_report.md) when opening a new issue.

A minimal reproduction example is very helpful to understand the issue and
inspect it locally.

## Proposing changes

This repository uses [`semantic-release`](https://semantic-release.gitbook.io/semantic-release/)
Expand Down

0 comments on commit 7c556ee

Please sign in to comment.