diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 288410d164..b634a5073c 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -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 @@ -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: @@ -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 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 6e2ba17272..c785cb9821 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,22 +1,21 @@ -### Summary +## Description -### Test plan +### Documentation -1. Visit the Deploy Preview ([insert link to specific page]()) ... + -### Relevant links (GitHub issues, Notion docs, etc.) or a picture of cute animal +## Tests -### Standard checks: + - +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. + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0e4edbaf60..1cbeeb9c27 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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.