README: split steps between setup and test run#38
Merged
Conversation
The QA method document in the cometbft repository currently refers to numbered ranges of steps in this README as setup and run sequences that the tester needs to perform at different stages. When the list of steps changes as it did in #35, updating these hardcoded references is tedious and error-prone (case in point, I failed to update quite a few places). The solution is to do to these human-consumed texts what programmers do to machine code and introduce subroutines! The step sequences are split under headers that can be "invoked" by name and anchored in the HTML rendering.
lasarojc
approved these changes
Feb 9, 2024
Contributor
lasarojc
left a comment
There was a problem hiding this comment.
Indeed, it was getting too confusing. Thanks for the rearranging.
github-merge-queue bot
pushed a commit
to cometbft/cometbft
that referenced
this pull request
Feb 9, 2024
Instead of hardcoded step numbers from qa-infra which are prone to falling out of date (as is the case now), refer to section anchors with the step "routines" in the reorganized README. Requires cometbft/qa-infra#38
mergify bot
pushed a commit
to cometbft/cometbft
that referenced
this pull request
Feb 9, 2024
Instead of hardcoded step numbers from qa-infra which are prone to falling out of date (as is the case now), refer to section anchors with the step "routines" in the reorganized README. Requires cometbft/qa-infra#38 (cherry picked from commit 830c650)
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
2 participants
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.
The QA method document in the cometbft repository currently refers to numbered ranges of steps in this README as setup and run sequences that the tester needs to perform at different stages.
When the list of steps changes as it did in #35, updating these hardcoded references is tedious and error-prone (case in point, I failed to update quite a few places).
The solution is to do to these human-consumed texts what programmers do to machine code and introduce subroutines!
The step sequences are split under headers that can be "invoked" by name and anchored in the HTML rendering.