Skip to content

chore: update issue & pr templates #2088

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 30 additions & 17 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,9 @@ body:
id: description
attributes:
label: Summary
description: A short description of the problem
description: Describe the problem you're seeing.
placeholder: |
Include what you expected to happen, and what actually happened.
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: Steps to reproduce the behavior
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
Be as precise as you can. Feel free to share screenshots, videos, or data from the devtools of your browser.
validations:
required: true
- type: input
Expand All @@ -35,11 +23,36 @@ body:
label: A link to a reproduction repository
description: The fastest way to describe your bug is to provide a reproduction repository.
placeholder: https://github.com/project/link-to-your-reproduction-repo

validations:
required: true
- type: markdown
attributes:
value: |
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.
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.
- type: textarea
attributes:
label: Expected Result
description: Describe what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Actual Result
description: Describe what actually happened.
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce
description: Steps to reproduce the behavior
placeholder: |
1.
2.
3.
4.
validations:
required: true
- type: input
id: runtime-version
attributes:
Expand All @@ -52,7 +65,7 @@ body:
- type: checkboxes
id: more-nextjs-info
attributes:
label: Is your issue related to the `app` directory (beta)?
label: Is your issue related to the `app` directory?
options:
- label: Yes, I am using the `app` directory

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

### Summary
## Description

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

### Test plan
### Documentation

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

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

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

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

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

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

🧪 Once merged, make sure to update the version if needed and that it was published correctly.
<!-- Link to an issue that is fixed by this PR or related to this PR. -->
14 changes: 12 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,5 +45,15 @@ Most common commit message prefixes are:

## Releasing

1. Merge the release PR
2. Run `npm publish`
This repository uses [release-please](https://github.com/googleapis/release-please) to automate its releases.

## How to make a minimal reproduction

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.

Steps to create a reproducible test case:

- Create a new Next.js site: `npx create-next-app@latest`
- 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.
- Verify that you're seeing the expected error(s) when running `netlify serve` and on a deployed version on [Netlify](https://www.netlify.com)
- 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.