Skip to content
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

docs(minimal reproductions): add perfect example #29316

Merged
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
14 changes: 13 additions & 1 deletion docs/development/minimal-reproductions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ We may ask you to create a "minimal reproduction" repository.

A minimal reproduction is a repository with the _least_ amount of code and config that still triggers missing or wrong behavior.

### Example of a perfect reproduction
rarkins marked this conversation as resolved.
Show resolved Hide resolved

The [`renovate-reproductions/12260` repository](https://github.com/renovate-reproductions/12260) shows a perfect reproduction, because it:

- Only has the files/config needed to trigger the bug
- Explains the current behavior and the expected behavior in the `readme.md`
- Links to the Renovate Issue, or Discussion in the `readme.md`
- Uses headings to organize information

## Creating a minimal reproduction

Please read this section in full _before_ starting on your minimal reproduction.
Expand All @@ -30,7 +39,10 @@ _Always_ follow these steps:
1. Use the fewest number of repository files and dependencies
1. Reduce your Renovate config to a minimum
1. Remove private or secret information
1. Create a `readme.md` file that explains the _current behavior_ and _expected behavior_
1. Create a `readme.md` file and:
- Explain the _Current behavior_ and _Expected behavior_
- Link to the Renovate Issue or Discussion
- Use headings to organize the information
HonkingGoose marked this conversation as resolved.
Show resolved Hide resolved
1. Set the repository visibility to `public`
1. Give us the link to the repository

Expand Down