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.

Sign up for GitHub

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

Jump to bottom

chore: link to reproduction template, improve instructions #29652

Merged
merged 3 commits into from
Jun 16, 2024
Merged

chore: link to reproduction template, improve instructions #29652

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
780223c
chore: link to reproduction template, improve instructions
HonkingGoose Jun 13, 2024
eeaeb36
Update minimal reproduction docs
HonkingGoose Jun 13, 2024
e9ef6e0
Merge branch 'main' into chore/29319-link-to-reproduction-template-up…
HonkingGoose Jun 15, 2024
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
9 changes: 8 additions & 1 deletion .github/label-actions.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,14 @@
Discussions without reproductions are less likely to be converted to Issues.


To get started, please read our guide on creating a [minimal reproduction](https://github.com/renovatebot/renovate/blob/main/docs/development/minimal-reproductions.md).
Please follow these steps:

1. Read our guide on creating a [minimal reproduction](https://github.com/renovatebot/renovate/blob/main/docs/development/minimal-reproductions.md).
2. Go to our [minimal reproduction template repository](https://github.com/renovatebot/minimal-reproduction-template).
3. Select the _Use this template_ button to create a new repository based on the template.
4. Work on the minimal reproduction in your own repository.
5. Fill out the information in your repository's `README.md`.
6. Add the link to your reproduction to the first post of your Discussion. If you are not the original author, you can post a new comment with the link.


Good luck,
Expand Down
12 changes: 6 additions & 6 deletions docs/development/minimal-reproductions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ Please read this section in full _before_ starting on your minimal reproduction.

There are two methods to create a reproduction, see the table for a comparison.

| Start point | Method | Benefits | Drawbacks |
| :------------------- | :---------------------- | :-------------------------------- | :----------------------------------------- |
| Empty repo | Copy files and config | Minimal start point | Crafting the bad config/setup from scratch |
| Fork production repo | Remove files and config | Start with known bad config/setup | May need to edit/delete many files |
| Start point | Method | Benefits | Drawbacks |
| :------------------------------------------------------------------------------------------------ | :---------------------- | :-------------------------------- | :----------------------------------------- |
| [our minimal reproduction template](https://github.com/renovatebot/minimal-reproduction-template) | Copy files and config | Minimal start point | Crafting the bad config/setup from scratch |
| Fork production repo | Remove files and config | Start with known bad config/setup | May need to edit/delete many files |

Either method will work.
We recommend you start from an empty repository.
We recommend you start from [our minimal reproduction template](https://github.com/renovatebot/minimal-reproduction-template).

### General steps

Expand All @@ -39,7 +39,7 @@ _Always_ follow these steps:
1. Use the fewest number of repository files and dependencies
rarkins marked this conversation as resolved.
Show resolved Hide resolved
1. Reduce your Renovate config to a minimum
1. Remove private or secret information
1. Create a `readme.md` file and:
1. Create a `readme.md` file (or edit the template `readme.md`) and:
- Explain the _Current behavior_ and _Expected behavior_
- Link to the Renovate Issue or Discussion
- Use headings to organize the information
Expand Down