Skip to content

Commit

Permalink
docs(minimal reproductions): add perfect example (#29316)
Browse files Browse the repository at this point in the history
  • Loading branch information
HonkingGoose committed May 30, 2024
1 parent d7954eb commit 82861f5
Showing 1 changed file with 13 additions and 1 deletion.
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

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
1. Set the repository visibility to `public`
1. Give us the link to the repository

Expand Down

0 comments on commit 82861f5

Please sign in to comment.