From 3c49e85273e0231de888be1a2c19d16953381a43 Mon Sep 17 00:00:00 2001
From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Date: Sun, 16 Jun 2024 08:30:53 +0200
Subject: [PATCH] chore: link to reproduction template, improve instructions
(#29652)
---
.github/label-actions.yml | 9 ++++++++-
docs/development/minimal-reproductions.md | 12 ++++++------
2 files changed, 14 insertions(+), 7 deletions(-)
diff --git a/.github/label-actions.yml b/.github/label-actions.yml
index 6f8463a1df..a41b8515d1 100644
--- a/.github/label-actions.yml
+++ b/.github/label-actions.yml
@@ -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,
diff --git a/docs/development/minimal-reproductions.md b/docs/development/minimal-reproductions.md
index a0c9bc7e9d..d4646dc18b 100644
--- a/docs/development/minimal-reproductions.md
+++ b/docs/development/minimal-reproductions.md
@@ -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
@@ -39,7 +39,7 @@ _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 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
--
GitLab