Skip to content

fix: improve clarity in workflow documentation steps after review#53

Merged
FidelusAleksander merged 1 commit into
skills:mainfrom
FidelusAleksander:main
Mar 10, 2026
Merged

fix: improve clarity in workflow documentation steps after review#53
FidelusAleksander merged 1 commit into
skills:mainfrom
FidelusAleksander:main

Conversation

@FidelusAleksander

@FidelusAleksander FidelusAleksander commented Mar 10, 2026

Copy link
Copy Markdown
Contributor

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 the reusable-node-quality.yml workflow 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 their ci.yml changes, 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

  • For workflow changes, I have verified the Actions workflows function as expected.
  • For content changes, I have reviewed the style guide.

Copilot AI review requested due to automatic review settings March 10, 2026 08:38

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.yml changes 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.

@FidelusAleksander
FidelusAleksander merged commit 8494a50 into skills:main Mar 10, 2026
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants