-
Notifications
You must be signed in to change notification settings - Fork 1
Add GitHub Copilot instructions configuration #87
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Co-authored-by: hckhanh <[email protected]>
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #87 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 3 3
Lines 191 216 +25
Branches 63 73 +10
=========================================
+ Hits 191 216 +25 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
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 adds comprehensive GitHub Copilot instructions to help the AI coding agent understand the project structure, tooling, and conventions for the fast-url library. The documentation covers development workflow, code standards, architecture, and contribution guidelines.
Key Changes
- Added
.github/copilot-instructions.mdwith 242 lines of comprehensive project documentation - Documented tech stack (TypeScript, Vitest, Biome, tsdown)
- Included development workflows, CI/CD processes, and quality standards
- Outlined restrictions and performance considerations
| **fast-url** is a high-performance TypeScript/JavaScript library for building URLs safely and conveniently. It's a fork of [urlcat](https://github.com/balazsbotond/urlcat) with a focus on performance and simplicity. | ||
|
|
||
| ### Key Features | ||
| - Lightweight with minimal dependencies (only fast-querystring) |
Copilot
AI
Nov 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The claim that fast-querystring is a dependency is incorrect. The package.json file shows no 'dependencies' section at all, meaning there are zero production dependencies. The query string functionality is implemented in the local src/querystring/ directory, not via an external package.
| - Lightweight with minimal dependencies (only fast-querystring) | |
| - Lightweight with zero production dependencies (query string functionality is implemented locally) |
| ## Dependencies | ||
|
|
||
| ### Production Dependencies | ||
| - **fast-querystring**: The only production dependency, used for query string building |
Copilot
AI
Nov 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is incorrect. The package.json file has no production dependencies. The query string functionality is implemented locally in src/querystring/stringify.ts and src/querystring/node.ts, not imported from fast-querystring. This section should either be removed or corrected to state 'No production dependencies'.
| - **fast-querystring**: The only production dependency, used for query string building | |
| - None (all query string functionality is implemented locally) |
| npm test | ||
|
|
||
| # Run tests with coverage | ||
| bun run test --coverage |
Copilot
AI
Nov 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] The command should be bun test --coverage (without run), as shown in the actual test.yml workflow which uses bun run test --coverage but the package.json script is just test: vitest. Using bun run test --coverage would work, but the simpler bun test --coverage is more consistent with line 56.
| bun run test --coverage | |
| bun test --coverage |
CodSpeed Performance ReportMerging #87 will not alter performanceComparing Summary
Footnotes
|



Summary
Configures GitHub Copilot coding agent per best practices to provide context about project structure, tooling, and conventions.
Details
Added
.github/copilot-instructions.mddocumenting:npm run build), test (npm test), format (npm run format)src/, tests intest/, single production dependency (fast-querystring)This enables Copilot to understand repository-specific patterns and avoid common mistakes when suggesting code changes.
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
gh.iocurl -L REDACTED(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.