Add reviewer guidelines for main providers (infra)#2091
Merged
Conversation
pieqq
requested changes
Aug 27, 2025
Collaborator
pieqq
left a comment
There was a problem hiding this comment.
As discussed internally, please add footnotes to justify why certain things need to be done a certain way.
Also, try to avoid using "we". I've made a few suggestions inline, but I didn't cover everything.
Co-authored-by: Pierre Equoy <pierre.equoy@canonical.com>
Co-authored-by: Pierre Equoy <pierre.equoy@canonical.com>
…kbox into provider_review_guideline
pieqq
approved these changes
Aug 28, 2025
stanley31huang
pushed a commit
that referenced
this pull request
Oct 3, 2025
* First draft of README.md * Fix formatting and add more do/dont * More rules for python scripts * Note to use raise SystemExit * Review feedback 1 Co-authored-by: Pierre Equoy <pierre.equoy@canonical.com> * Rephrase why no dependencies Co-authored-by: Pierre Equoy <pierre.equoy@canonical.com> * Give a rationale for each rule * Fix links to be interactive --------- Co-authored-by: Pierre Equoy <pierre.equoy@canonical.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This adds a guideline for reviewing PRs to the main providers in Checkbox. This can be used by authors to avoid common pitfalls when developing Checkbox tests.
Resolved issues
Fixes: https://warthogs.atlassian.net/browse/CHECKBOX-1988
Documentation
This is documentation
Tests
N/A