Skip to content

Commit 5d2528e

Browse files
LekoArtskarlhorky
andauthored
chore: Improve docs around minimal reproduction (#36188)
Co-authored-by: Karl Horky <[email protected]>
1 parent d42243c commit 5d2528e

File tree

3 files changed

+17
-4
lines changed

3 files changed

+17
-4
lines changed

.github/ISSUE_TEMPLATE/BUG_REPORT.yml

+8-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,14 @@ body:
3737
attributes:
3838
label: Reproduction Link
3939
placeholder: "https://github.com/username/repository-name/"
40-
description: "Link to a reproduction (GitHub repository, Codesandbox, etc.). **Do not link to your actual project**, but provide a minimal reproduction in a fresh project -- how to make a minimal reproduction: https://gatsby.dev/reproduction"
40+
description: |
41+
Link to a minimal reproduction (GitHub repository, CodeSandbox, StackBlitz, etc.).
42+
43+
**Do not link to your actual project**, but provide a minimal reproduction in a fresh project — how to make a minimal reproduction: https://gatsby.dev/reproduction
44+
45+
You can use these links to quickly set up a new reproduction:
46+
- CodeSandbox: https://githubbox.com/gatsbyjs/gatsby-starter-minimal
47+
- StackBlitz: https://githubblitz.com/gatsbyjs/gatsby-starter-minimal
4148
validations:
4249
required: true
4350
- type: textarea

docs/contributing/how-to-make-a-reproducible-test-case.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,12 @@ A reproducible test case is a great way to share a specific environment that cau
2121
- Add the code needed to recreate the error you've seen.
2222
- Publish the code (your GitHub account is a good place to do this) and then link to it when [creating an issue](/contributing/how-to-file-an-issue/).
2323

24-
## Places to develop a reproducible test case
24+
## Online Development Environments
2525

26-
- Locally with a starter: You can start with a starter locally and then build it on your own machine. Gatsby's official [`gatsby-starter-minimal`](https://github.com/gatsbyjs/gatsby-starter-minimal) is a good foundation for a reproducible test case.
27-
- Host on CodeSandbox: You can develop a Gatsby site straight from your browser with CodeSandbox using their [Gatsby template](https://codesandbox.io/s/github/gatsbyjs/gatsby-starter-default). CodeSandbox also hosts your site automatically, which can be useful to demonstrate the behavior of your site.
26+
Instead of cloning `gatsby-starter-minimal` to your local computer and working on it there, you can also use Online IDEs that set up the environment for you. Available options:
27+
28+
- [CodeSandbox](https://githubbox.com/gatsbyjs/gatsby-starter-minimal)
29+
- [StackBlitz](https://githubblitz.com/gatsbyjs/gatsby-starter-minimal)
2830

2931
## Benefits of reproducible test cases
3032

docs/contributing/rfc-process.md

+4
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,10 @@ In short, to get a major feature added to Gatsby, one usually first puts up a Di
4848

4949
<!-- When defining a canary for installation, tell users to use `--save-exact` (npm) or `--exact` (yarn) flag. -->
5050

51+
### CodeSandbox
52+
53+
Provide an up-to-date CodeSandbox with an example project using the canary. Users can use this project to provide minimal reproductions.
54+
5155
## Basic example
5256

5357
If the proposal involves a new or changed API, include a basic code example.

0 commit comments

Comments
 (0)