Conversation
- Update authentication instructions to use 'copilot --allow-all' and '!gh auth login' - Replace /share gist with /context command in step 1 activities - Improve prompt clarity for creating GitHub issues with specific template references - Update workflow validation to check for 'addition', 'subtraction', 'multiplication', 'division' instead of 'add', 'subtract', 'multiply', 'divide' - Add helpful notes about copilot --allow-all and viewing test output - Refine prompts for better learner experience - Update calculator operations image
- Update workflow to check for 'modulo', 'power', and 'square root' tests instead of 'multiply', 'divide', 'sqrt' - Fix /share command reference to /share gist in step 4 tip
- Replace descriptive text with actual command syntax - Show [file|gist] [path] parameters explicitly - Makes command usage clearer and more actionable
There was a problem hiding this comment.
Pull request overview
This pull request updates documentation and workflow validation files for a GitHub Copilot CLI learning tutorial focused on building a calculator application. The PR aims to improve clarity and accuracy of instructions while updating workflow checks to validate learner progress.
Changes:
- Updated authentication instructions across all step files to recommend
copilot --allow-allafter codespace restarts and standardized on!gh auth loginfor GitHub authentication - Modified workflow validation keyphrases in steps 2 and 3 to check for more descriptive operation names
- Enhanced documentation with clearer command examples, better explanations of Copilot CLI features, and additional tips for learners
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| images/calc-basic-operations.png | New or updated screenshot showing calculator operations (binary file) |
| .github/workflows/2-step.yml | Updated keyphrase checks for calculator functions from verb forms (add, subtract, multiply, divide) to noun forms (addition, subtraction, multiplication, division) |
| .github/workflows/3-step.yml | Updated keyphrase checks for advanced operations from abbreviated forms (multiply, divide, sqrt) to descriptive forms (modulo, power, square root) |
| .github/steps/1-step.md | Standardized authentication commands, updated /share documentation, replaced /login with !gh auth login, and added explanatory notes |
| .github/steps/2-step.md | Updated authentication instructions, clarified repository references, improved command examples, and added tip about viewing test output |
| .github/steps/3-step.md | Enhanced authentication guidance, improved issue creation prompts with clearer repository references, and updated operation implementation instructions |
| .github/steps/4-step.md | Clarified authentication instructions and updated /share command documentation to specify gist option |
Comments suppressed due to low confidence (3)
.github/workflows/2-step.yml:74
- The workflow is checking for the keyphrase "subtraction" in calculator.js, but typical JavaScript function names would use "subtract" not "subtraction". This keyphrase check may fail if developers follow standard naming conventions (e.g.,
function subtract(a, b)). Consider aligning the keyphrase with expected function naming patterns.
- name: Check if calculator.js has subtraction function
id: check-subtraction-function
continue-on-error: true
uses: skills/action-keyphrase-checker@v1
with:
text-file: src/calculator.js
keyphrase: subtraction
.github/workflows/2-step.yml:82
- The workflow is checking for the keyphrase "multiplication" in calculator.js, but typical JavaScript function names would use "multiply" not "multiplication". This keyphrase check may fail if developers follow standard naming conventions (e.g.,
function multiply(a, b)). Consider aligning the keyphrase with expected function naming patterns.
- name: Check if calculator.js has multiplication function
id: check-multiplication-function
continue-on-error: true
uses: skills/action-keyphrase-checker@v1
with:
text-file: src/calculator.js
keyphrase: multiplication
.github/workflows/2-step.yml:90
- The workflow is checking for the keyphrase "division" in calculator.js, but typical JavaScript function names would use "divide" not "division". This keyphrase check may fail if developers follow standard naming conventions (e.g.,
function divide(a, b)). Consider aligning the keyphrase with expected function naming patterns.
- name: Check if calculator.js has division function
id: check-division-function
continue-on-error: true
uses: skills/action-keyphrase-checker@v1
with:
text-file: src/calculator.js
keyphrase: division
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@arilivigni I've opened a new pull request, #15, to work on those changes. Once the pull request is ready, I'll request review from you. |
|
@arilivigni I've opened a new pull request, #16, to work on those changes. Once the pull request is ready, I'll request review from you. |
This pull request updates documentation and workflow files to improve clarity, accuracy, and alignment with current Copilot CLI commands and calculator requirements. The changes mainly focus on updating instructions for authentication, command usage, and test/feature validation in the learning steps and CI workflows.
Documentation and Instruction Improvements:
copilot --allow-allafter codespace restarts, and standardize on using!gh auth loginfor GitHub authentication. [1] [2] [3] [4]/sharecommand usage, improving explanations for/context,/session, and issue creation prompts, and making instructions more explicit about where issues are created. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]Workflow and Automated Check Updates:
.github/workflows/2-step.ymlto check for calculator functions using more precise terminology (e.g., 'addition' instead of 'add'), and updated corresponding result descriptions. [1] [2].github/workflows/3-step.ymlto check for new test cases (modulo, power, square root) incalculator.tests.jswith clearer step names and result descriptions. [1] [2]General Consistency and Clarity:
copilot --allow-alland how to view test outputs in Copilot CLI. [1] [2]These changes collectively make onboarding and workflow steps easier to follow and ensure that automated checks accurately reflect the required calculator features and tests.