chore: add copilot-instructions.md for GitHub Copilot coding agent#5891
chore: add copilot-instructions.md for GitHub Copilot coding agent#5891chenjiahan merged 4 commits intomainfrom
Conversation
|
@chenjiahan 👋 This repository doesn't have Copilot instructions. With Copilot instructions, I can understand the repository better, work faster and produce higher quality PRs. I can generate a .github/copilot-instructions.md file for you automatically. Click here to open a pre-filled issue and assign it to me. I'll write the instructions, and then tag you for review. |
✅ Deploy Preview for rsbuild ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
Co-authored-by: chenjiahan <7237365+chenjiahan@users.noreply.github.com>
|
@copilot Make this guide more concise |
Co-authored-by: chenjiahan <7237365+chenjiahan@users.noreply.github.com>
Made the guide more concise - reduced from 185 lines to 66 lines (64% reduction) while preserving all essential information. Consolidated related sections, removed redundant formatting, and streamlined the structure. Commit: 568d8ea |
There was a problem hiding this comment.
Pull Request Overview
This PR adds a concise reference guide for GitHub Copilot coding agents working in the Rsbuild repository. The instructions provide essential setup procedures, development workflows, and repository navigation guidance in a streamlined 54-line format.
Key changes:
- Added comprehensive setup instructions with timing expectations and "NEVER CANCEL" warnings
- Included development workflow commands for testing, building, and code quality checks
- Provided repository structure overview with key directories and their purposes
| ```bash | ||
| pnpm test # Unit tests (~10s) | ||
| pnpm e2e # E2E tests (~60s) | ||
| pnpm lint # Lint code (~5s) - REQUIRED before finishing |
There was a problem hiding this comment.
The comment 'REQUIRED before finishing' is ambiguous. Consider clarifying what 'finishing' means - is this before committing, before submitting a PR, or before completing development work?
| pnpm lint # Lint code (~5s) - REQUIRED before finishing | |
| pnpm lint # Lint code (~5s) - REQUIRED before committing or submitting a pull request |
|
|
||
| - Rsbuild CLI commands: `dev`, `build`, `preview`, `inspect` | ||
| - Uses NX for builds, Rslib for bundling | ||
| - Node.js 22+ |
There was a problem hiding this comment.
The Node.js version requirement appears incomplete. Consider adding context about whether this is a minimum requirement and if it's consistent with the project's package.json engines field.
| - Node.js 22+ | |
| - Requires Node.js >=22 (see `package.json` `engines` field) |
This PR adds streamlined instructions for GitHub Copilot coding agents working in the Rsbuild repository. The instructions provide essential guidance on setup, development workflows, and repository navigation in a concise format.
Key Features
Setup & Build Instructions:
Development Workflows:
Concise Format:
The instructions follow an imperative tone and include timeout recommendations to prevent premature cancellation of long-running operations.
Fixes #5890.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.