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

docs: minimal reproduction documentation #8107

Merged

Conversation

HonkingGoose
Copy link
Collaborator

Changes:

Create a document in the docs/development folder that:

  • explains what a minimal reproduction is
  • tells why we need bug reporters to create a minimal reproduction
  • has tips to make a good reproduction repository

Context:

Closes #8099.

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please tick one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added unit tests, or
  • Unit tests + ran on a real repository

@HonkingGoose
Copy link
Collaborator Author

@rarkins, I have some questions about things you said in #8099

what a minimal reproduction is, with examples and counter-examples. we could link to some real examples, although it's always possible that users could delete them eventually once the problem is solved

How about we create a renovate/reproduction-examples repo, that contains example(s) of a good and bad reproduction.
That way we keep control of the content to which we link, and ensure the example repository is always available.

We can also try to help guide people about how to reproduce a problem with private repos or private registries enough that someone else can take it over.

This is not yet in the document, as I don't know what the text should describe.


I was going to write something like The Renovate team will help you if you get stuck making the reproduction repository.
But I don't know if that's what the team wants to do...
So I'm asking first: Does the Renovate team want to invest time in helping the bug reporter with the reproduction repository?
Or do we consider that to be just as bad "a waste of time" as debugging on a production repo?

docs/development/minimal-reproductions.md Outdated Show resolved Hide resolved
docs/development/minimal-reproductions.md Outdated Show resolved Hide resolved
@HonkingGoose
Copy link
Collaborator Author

@rarkins I think we also need to add a link to this new document from the issue templates where appropriate?

@rarkins
Copy link
Collaborator

rarkins commented Dec 22, 2020

@HonkingGoose yes, we can add it to the bug template. Maybe "Have you created a minimal reproduction repository?" and link "reproduction repository" to the docs page

@HonkingGoose
Copy link
Collaborator Author

I'll go and add that to the bug template then. 😄

@rarkins
Copy link
Collaborator

rarkins commented Dec 22, 2020

We can only do that once it's published.

@HonkingGoose
Copy link
Collaborator Author

HonkingGoose commented Dec 22, 2020

Oh okay, I thought it would be good to include it in this PR, so that we don't forget later on. 😄

EDIT: Made a new issue to remind us of this work after this PR gets its final review and merge.

@HonkingGoose HonkingGoose marked this pull request as ready for review December 22, 2020 12:56
@rarkins rarkins merged commit 2dd665b into renovatebot:master Dec 22, 2020
@HonkingGoose HonkingGoose deleted the docs/explain-minimal-reproduction branch December 22, 2020 13:01
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 24.10.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 22, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: minimal reproduction repository
3 participants