Readme for robots #390
Merged
Readme for robots #390
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a dedicated GitHub Actions workflow for validating Copilot setup steps and adds a detailed Copilot instructions document.
- Adds
.github/workflows/copilot-setup-steps.ymlto run and verify Copilot’s setup viaworkflow_dispatch. - Creates
.github/copilot-instructions.mdwith environment, testing, bundling, project guidelines, and repository structure.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| .github/workflows/copilot-setup-steps.yml | New workflow to check out code, install dependencies, and prepare Copilot setup |
| .github/copilot-instructions.md | New markdown guide covering bootstrap, tests, bundling, and best practices |
Comments suppressed due to low confidence (1)
.github/workflows/copilot-setup-steps.yml:25
- The workflow lacks a step to run tests and enforce coverage, even though the instructions require 100% test coverage. Consider adding a
npm run test -- --coverageor equivalent step after installing dependencies.
- name: install dependencies
| - more descriptive names over brevity of variable, function, and class names | ||
| - the use of whitespace (newlines) over compactness of files | ||
| - naming of variables and methods that lead to expressions and blocks reading more like English sentences. | ||
| - less lines of code over more. Keep changes minimal and focused. |
There was a problem hiding this comment.
Use "fewer lines of code" instead of "less lines of code" to correct the grammar.
Suggested change
| - less lines of code over more. Keep changes minimal and focused. | |
| - fewer lines of code over more. Keep changes minimal and focused. |
Copilot uses AI. Check for mistakes.
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 pull request adds a copilot instructions file and also a copilot setup workflow.