From 1dd34620fd29d957fba42284662dedf98a110dcc Mon Sep 17 00:00:00 2001 From: Jan Kaifer Date: Fri, 25 Nov 2022 13:01:39 +0100 Subject: [PATCH] Add example commands for creating reproductions (#43375) To reduce friction when creating reproductions. It allso allows me to link to this file when I'm asking people to create reproductions ## Bug - [ ] Related issues linked using `fixes #number` - [ ] Integration tests added - [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md) ## Feature - [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. - [ ] Related issues linked using `fixes #number` - [ ] [e2e](https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) tests added - [ ] Documentation added - [ ] Telemetry added. In case of a feature if it's used or not. - [ ] Errors have a helpful link attached, see [`contributing.md`](https://github.com/vercel/next.js/blob/canary/contributing.md) ## Documentation / Examples - [x] Make sure the linting passes by running `pnpm build && pnpm lint` - [ ] The "examples guidelines" are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md) --- examples/reproduction-template/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/examples/reproduction-template/README.md b/examples/reproduction-template/README.md index 8085f19c1181..f0e70790af0f 100644 --- a/examples/reproduction-template/README.md +++ b/examples/reproduction-template/README.md @@ -9,6 +9,22 @@ These are the steps you should follow when creating a bug report: - If you think the issue is not in Next.js, the best place to ask for help is our [Discord community](https://nextjs.org/discord) or [GitHub discussions](https://github.com/vercel/next.js/discussions). Our community is welcoming and can often answer a project-related question faster than the Next.js core team. - Make the reproduction as minimal as possible. Try to exclude any code that does not help reproducing the issue. E.g. if you experience problems with Routing, including ESLint configurations or API routes aren't necessary. The less lines of code is to read through, the easier it is for the Next.js team to investigate. It may also help catching bugs in your codebase before publishing an issue. +## How to use this template + +Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example: + +```bash +npx create-next-app --example reproduction-template reproduction-app +``` + +```bash +yarn create next-app --example reproduction-template reproduction-app +``` + +```bash +pnpm create next-app --example reproduction-template reproduction-app +``` + ## Learn More To learn more about Next.js, take a look at the following resources: