Skip to content

Commit cb8d3ea

Browse files
Merge branch 'main' into release-please--branches--main
2 parents be9ce73 + 5e48022 commit cb8d3ea

File tree

3 files changed

+51
-29
lines changed

3 files changed

+51
-29
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,9 @@ body:
1212
id: description
1313
attributes:
1414
label: Summary
15-
description: A short description of the problem
15+
description: Describe the problem you're seeing.
1616
placeholder: |
17-
Include what you expected to happen, and what actually happened.
18-
validations:
19-
required: true
20-
- type: textarea
21-
id: steps-to-reproduce
22-
attributes:
23-
label: Steps to reproduce
24-
description: Steps to reproduce the behavior
25-
placeholder: |
26-
1. Go to '...'
27-
2. Click on '....'
28-
3. Scroll down to '....'
29-
4. See error
17+
Be as precise as you can. Feel free to share screenshots, videos, or data from the devtools of your browser.
3018
validations:
3119
required: true
3220
- type: input
@@ -35,11 +23,36 @@ body:
3523
label: A link to a reproduction repository
3624
description: The fastest way to describe your bug is to provide a reproduction repository.
3725
placeholder: https://github.com/project/link-to-your-reproduction-repo
38-
26+
validations:
27+
required: true
3928
- type: markdown
4029
attributes:
4130
value: |
42-
Check out [CONTRIBUTING.md](https://github.com/netlify/next-runtime/blob/main/CONTRIBUTING.md#what-is-a-reproducible-test-case) for advice on producing a reproduction repo.
31+
Check out [our contributing guide](https://github.com/netlify/next-runtime/blob/main/CONTRIBUTING.md#how-to-make-a-minimal-reproduction) for advice on producing a reproduction repo.
32+
- type: textarea
33+
attributes:
34+
label: Expected Result
35+
description: Describe what you expected to happen.
36+
validations:
37+
required: true
38+
- type: textarea
39+
attributes:
40+
label: Actual Result
41+
description: Describe what actually happened.
42+
validations:
43+
required: true
44+
- type: textarea
45+
id: steps-to-reproduce
46+
attributes:
47+
label: Steps to reproduce
48+
description: Steps to reproduce the behavior
49+
placeholder: |
50+
1.
51+
2.
52+
3.
53+
4.
54+
validations:
55+
required: true
4356
- type: input
4457
id: runtime-version
4558
attributes:
@@ -52,7 +65,7 @@ body:
5265
- type: checkboxes
5366
id: more-nextjs-info
5467
attributes:
55-
label: Is your issue related to the `app` directory (beta)?
68+
label: Is your issue related to the `app` directory?
5669
options:
5770
- label: Yes, I am using the `app` directory
5871

.github/pull_request_template.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
<!-- Before opening a pull request, ensure you've read our contributing guidelines, https://github.com/netlify/next-runtime/blob/main/CONTRIBUTING.md. -->
22

3-
### Summary
3+
## Description
44

55
<!-- Provide a brief summary of the change. -->
66

7-
### Test plan
7+
### Documentation
88

9-
1. Visit the Deploy Preview ([insert link to specific page]()) ...
9+
<!-- Where is this feature or API documented? Did you create an internal and/or external artifact to document this change? -->
1010

11-
### Relevant links (GitHub issues, Notion docs, etc.) or a picture of cute animal
11+
## Tests
1212

13-
### Standard checks:
13+
<!-- Did you add tests? How did you test this change? -->
1414

15-
<!-- Please delete any options that reviewers shouldn't check. -->
15+
You can test this change yourself like so:
1616

17-
- [ ] Check the Deploy Preview's Demo site for your PR's functionality
18-
- [ ] Add docs when necessary
17+
1. TODO
1918

20-
---
19+
## Relevant links (GitHub issues, etc.) or a picture of cute animal
2120

22-
🧪 Once merged, make sure to update the version if needed and that it was published correctly.
21+
<!-- Link to an issue that is fixed by this PR or related to this PR. -->

CONTRIBUTING.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,5 +45,15 @@ Most common commit message prefixes are:
4545

4646
## Releasing
4747

48-
1. Merge the release PR
49-
2. Run `npm publish`
48+
This repository uses [release-please](https://github.com/googleapis/release-please) to automate its releases.
49+
50+
## How to make a minimal reproduction
51+
52+
A reproducible test case is a small Next.js site built to demonstrate a problem - often this problem is caused by a bug in Next.js, next-runtime or user code. Your reproducible test case should contain the bare minimum features needed to clearly demonstrate the bug.
53+
54+
Steps to create a reproducible test case:
55+
56+
- Create a new Next.js site: `npx create-next-app@latest`
57+
- Add any code or functionality related to the issue. For example, if you have problems with middleware functionality you should add all the necessary code of your middleware.
58+
- Verify that you're seeing the expected error(s) when running `netlify serve` and on a deployed version on [Netlify](https://www.netlify.com)
59+
- Publish the code (your GitHub account is a good place to do this) and then link to it when creating an issue. While creating the issue, please give as many details as possible. This could also include screenshots of error messages.

0 commit comments

Comments
 (0)