Contributor guide review #5840
Merged
Contributor guide review #5840
Conversation
This file contains 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
|
Dear contributor,
As for the Avocado utility modules (“avocado.utils”) it is OK to introduce new functionality, |
clebergnu
force-pushed
the
contributor_guide_review
branch
from
9f5a5f5
to
e431766
Compare
richtja
requested changes
Dec 23, 2023
There was a problem hiding this comment.
Hi @clebergnu, thank you for this refactoring. Overall it LGTM, I just found few typos and can you please do the rebase to #5839, thank you.
clebergnu
force-pushed
the
contributor_guide_review
branch
from
e431766
to
eb3420e
Compare
|
Thanks for the review @richtja, I've addressed all the issues you've found. |
Signed-off-by: Cleber Rosa <[email protected]>
It looks like readthedocs.org no longer overrides the theme when it's building the docs. Let's always try to se the rtd theme, unless it's not available, that includes on readthedocs.org (where it should always be available). Signed-off-by: Cleber Rosa <[email protected]>
…list Signed-off-by: Cleber Rosa <[email protected]>
Signed-off-by: Cleber Rosa <[email protected]>
clebergnu
force-pushed
the
contributor_guide_review
branch
from
eb3420e
to
5a5c09f
Compare
richtja
requested changes
Dec 24, 2023
There was a problem hiding this comment.
Hi @clebergnu thank you for your updates. Unfortunately, I think I found one more typo.
Contributing docs is not that different from other contributions, but let's add the missing bits. Signed-off-by: Cleber Rosa <[email protected]>
Signed-off-by: Cleber Rosa <[email protected]>
All of the Avocado project (and pretty much every single Open Source project) needs help. It feels pointless to me to have this on a couple of locations in the docs. Let's keep track of known documentation related tasks along with all the other known issues (GH Issues). Signed-off-by: Cleber Rosa <[email protected]>
The information on setting up the GPG environment is outdated and pretty much all in the "style guide" chapter. Let's update it and organize it better between "setting up" (environment) and using it (style guide). Signed-off-by: Cleber Rosa <[email protected]>
Avocado uses Black for code style enforcement, so the contributor should really refer to it for any information on the topic. Signed-off-by: Cleber Rosa <[email protected]>
And while at it, let's shorten the lengths of the lines around it. Signed-off-by: Cleber Rosa <[email protected]>
Signed-off-by: Cleber Rosa <[email protected]>
Signed-off-by: Cleber Rosa <[email protected]>
Signed-off-by: Cleber Rosa <[email protected]>
clebergnu
force-pushed
the
contributor_guide_review
branch
from
5a5c09f
to
b718763
Compare
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.
This is part of #5757.