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

Rewrite minimal reproduction guide to get to the point quicker #28730

Closed
7 of 9 tasks
HonkingGoose opened this issue Apr 29, 2024 · 3 comments · Fixed by #29275
Closed
7 of 9 tasks

Rewrite minimal reproduction guide to get to the point quicker #28730

HonkingGoose opened this issue Apr 29, 2024 · 3 comments · Fixed by #29275
Assignees
Labels
priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others status:in-progress Someone is working on implementation type:docs Documentation

Comments

@HonkingGoose
Copy link
Collaborator

HonkingGoose commented Apr 29, 2024

Describe the proposed change(s).

Rewrite the minimal reproduction guide 1, so that users can get started creating the reproduction quicker:

  • Refactor current docs with: docs: improve minimal reproductions guide #28926
  • Move actionable information up front
  • Move background info down
  • Rewrite for simplicity:
    • Simpler words
    • Short sentences
    • Use lists if needed
    • Focus on the reader
    • Update links that point to minimal-reproductions.md

Footnotes

  1. docs/development/minimal-reproductions.md

@HonkingGoose HonkingGoose added priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others type:docs Documentation labels Apr 29, 2024
@HonkingGoose HonkingGoose self-assigned this Apr 29, 2024
@HonkingGoose HonkingGoose added the status:in-progress Someone is working on implementation label May 27, 2024
@renovate-release
Copy link
Collaborator

🎉 This issue has been resolved in version 37.379.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@karlhorky
Copy link
Contributor

karlhorky commented May 28, 2024

@HonkingGoose Thanks for #29275 👍 nice improvements.

To make the guide even more approachable for contributors, I would suggest dropping + simplifying steps, including dropping the readme.md (the description should be in a discussion or issue anyway):

-1. Put your minimal reproduction repository on GitHub, only use GitLab or Bitbucket if needed
+1. Put your minimal reproduction repository on GitHub, only use GitLab or Bitbucket if needed (make sure the repo is public)
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. Set the repository visibility to `public`
-1. Give us the link to the repository

Also, for some first baby steps in the direction of a minimal reproduction template, I would add an example config link to step 3:

-1. Reduce your Renovate config to a minimum
+1. Reduce your Renovate config to a minimum (eg. [simple base config starter](https://example.com))

Then, if the idea of a minimum reproduction template is amenable to the Renovate team, this could be expanded to multiple GitHub repo templates - one for each for each package manager (eg. including an empty package.json for Node.js projects), to get closer to the "one-click starter" idea that I mentioned.

@rarkins
Copy link
Collaborator

rarkins commented May 28, 2024

I disagree about dropping the readme. In a large % of cases, reproduction repositories are not self-explanatory, even with the associated discussion

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority-3-medium Default priority, "should be done" but isn't prioritised ahead of others status:in-progress Someone is working on implementation type:docs Documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants