config(github): add agents and instructions files#14
Merged
Conversation
|
Coverage after merging config-github-add-copilot-agents-and-instructions-files into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shouze
force-pushed
the
config-github-add-copilot-agents-and-instructions-files
branch
from
300131d to
4a85929
Compare
|
Coverage after merging config-github-add-copilot-agents-and-instructions-files into main will be
Coverage Report
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shouze
deleted the
config-github-add-copilot-agents-and-instructions-files
branch
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for AI coding agents working in the repository. It introduces an AGENTS.md file at the root and three task-specific instruction files in .github/instructions/ to guide Copilot through refactoring, feature implementation, and bug fixing workflows.
Changes:
- Added AGENTS.md documenting project structure, runtime/toolchain, architectural principles, and development workflow
- Added refactoring.instructions.md with step-by-step guidance for refactoring tasks
- Added implement-feature.instructions.md with step-by-step guidance for implementing new features
- Added bug-fixing.instructions.md with step-by-step guidance for fixing bugs
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| AGENTS.md | Comprehensive agent documentation covering project overview, toolchain, architecture, file structure, and development practices |
| .github/instructions/refactoring.instructions.md | Structured guidance for refactoring tasks with architectural boundaries and validation steps |
| .github/instructions/implement-feature.instructions.md | Structured guidance for feature development with layering rules and testing requirements |
| .github/instructions/bug-fixing.instructions.md | Structured guidance for bug fixes with root cause analysis and verification steps |
| bun test --watch # re-run on file changes (development) | ||
| ``` | ||
|
|
||
| All tests use Bun's built-in test runner (`@jest/globals`-compatible API: `describe`, `it`, `expect`). No additional testing library is needed. The setup file is `src/test-setup.ts` (referenced in `bunfig.toml`). |
There was a problem hiding this comment.
The description of the test API is misleading. Tests import from "bun:test", not from "@jest/globals". While Bun's test API is jest-compatible, the actual import source should be accurately documented as "bun:test" to help developers understand the toolchain.
Suggested change
| All tests use Bun's built-in test runner (`@jest/globals`-compatible API: `describe`, `it`, `expect`). No additional testing library is needed. The setup file is `src/test-setup.ts` (referenced in `bunfig.toml`). | |
| All tests use Bun's built-in test runner, importing from `bun:test` (API compatible with `@jest/globals`: `describe`, `it`, `expect`). No additional testing library is needed. The setup file is `src/test-setup.ts` (referenced in `bunfig.toml`). |
| bun install # install dependencies (reads bunfig.toml + package.json) | ||
| ``` | ||
|
|
||
| `bunfig.toml` sets `smol = true` (lighter install). No additional setup step is needed. |
There was a problem hiding this comment.
The statement that "bunfig.toml sets smol = true (lighter install)" is inaccurate. The current bunfig.toml file only contains test-related configuration and does not include a smol setting.
Suggested change
| `bunfig.toml` sets `smol = true` (lighter install). No additional setup step is needed. | |
| `bunfig.toml` currently only contains test-related configuration (e.g. test setup file). No additional setup step is needed. |
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
1 participant
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.
No description provided.