Skip to content
Snippets Groups Projects
Unverified Commit 3c49e852 authored by HonkingGoose's avatar HonkingGoose Committed by GitHub
Browse files

chore: link to reproduction template, improve instructions (#29652)

parent 32c96360
No related branches found
No related tags found
No related merge requests found
......@@ -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,
......
......@@ -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
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment