fix: improve clarity in workflow documentation steps after review#53
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the GitHub Actions exercise workflow documentation to make a few instructions clearer and the PR comment example more readable.
Changes:
- Improves the example PR comment table header in Step 3.
- Clarifies that learners should both commit and push their
ci.ymlchanges in Step 3. - Adjusts wording in Steps 1 and 2 to better specify where/how to add the provided workflow content.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .github/steps/1-step.md | Clarifies that the provided workflow content should be added to the bottom of the file. |
| .github/steps/2-step.md | Rewords the instruction to “add” the workflow content (and adds a comma for readability). |
| .github/steps/3-step.md | Replaces an empty table header with labeled columns; clarifies “commit and push”. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
chriswblake
approved these changes
Mar 10, 2026
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.
Summary
Changes
This pull request makes several improvements to the GitHub Actions workflow documentation for Node.js projects. The changes clarify instructions, improve the formatting of workflow-generated comments, and ensure users are guided to push their changes. These updates help make the workflow setup process more user-friendly and reduce potential confusion.
Documentation and instruction clarity:
.github/steps/1-step.md: Clarified where to add the workflow content by specifying it should be added to the bottom of thereusable-node-quality.ymlworkflow file, rather than just the file itself..github/steps/2-step.md: Improved the instruction wording to direct users to add (rather than copy) workflow content, making the process clearer..github/steps/3-step.md: Updated instructions to explicitly tell users to commit and push theirci.ymlchanges, ensuring the workflow is triggered.Formatting improvements:
.github/steps/3-step.md: Enhanced the table formatting in the workflow-generated pull request comment by clarifying column headers and making the table more readable.Closes:
Task list