Create page: How to Create a Minimal Reproduction

[daun]

This is an attempt to make discussions and issue reports more pleasant for maintainers. There's been a few discussions recently where a link to this would have come in handy, so I figured I'd just create it.

Description

• Add a page about minimal reproductions we can link to
• Explain why we ask for them in issue reports and help requests
• Summarize the advantages for maintainers and consumers
• Describe how and where to create one
• Not listed in navigation, only meant to be linked to directly

Preview

Link to page in deploy preview: How to Create a Minimal Reproduction

Terminology

• After lots of googling, the term "minimal reproduction" seems to be more common and widely understood
• I also like that "minimal" is already in the title, naming both key concepts: minimal + reproducible
• I've added "reproducible test case" to the intro as well, in case of ambiguity

To-do

• Add direct links to starter templates where possible: Replit, CodeSandbox
• Update the existing template on Replit to use swup v4
• Update the existing template on CodeSandbox to use swup v4

Checks

• The PR is submitted to the master branch
• The code was linted before pushing (npm run lint)
• All tests are passing (npm run test)

[netlify]

✅ Deploy Preview for splendorous-kataifi-9ae281 ready!

Name	Link
🔨 Latest commit	8293afc
🔍 Latest deploy log	https://app.netlify.com/sites/splendorous-kataifi-9ae281/deploys/6565d0cbea07800008596149
😎 Deploy Preview	https://deploy-preview-170--splendorous-kataifi-9ae281.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[hirasso]

Very nice!

[hirasso]

We could then link to this page from our issue/discussion templates. That's how astro is doing it (link "Read our guide"):

[daun]

@hirasso The astro example is great! I was thinking of creating a create-swup repo so that npm create swup would work as a starting point for minimal reproductions on GitHub, but I'd rather not encourage GitHub repos we need to check out. Better to stick with online IDEs, in my opinion.

[daun]

We also need to make sure the existing templates on Replit and CodeSandbox actually use the current major version of swup and plugins.

[daun]

@hirasso Could you update the CodeSandbox template to use swup 4? If it's possible — I remember there being an issue since we started using export maps in package.json. It's in your account, from what it looks like. I'll take care of the Replit template.

[hirasso]

👍 I'll try to update CodeSandbox to swup 4.

Today I stumbled upon this blog post by Anthony Fu: Why Reproductions are Required. Very clear and concise in my opinion! Closing issues/discussions temporarily until they receive a minimal reproduction as outlined in the post seems to me like a very promising approach. We could also think about copying some of the blog post (for example the quote about what OSS is) in our docs page. What do you think @daun?

I also like this part a lot:

In my opinion, asking for minimal reproduction is asking for equity of the effort spent.

[hirasso]

Damnit, I accidentally deleted the swup 3 sandbox. But oh well, here's a working version with swup 4:

https://codesandbox.io/p/devbox/swup-4-minimal-reproduction-template-n6kgnp

[daun]

@hirasso Feel free to merge :)

[hirasso]

👏