Add comprehensive Copilot coding agent instructions#5
Merged
Conversation
Co-authored-by: IBJunior <48456829+IBJunior@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Your task is to "onboard" this repository to Copilot coding agent by adding a .github/copilot-instructions.md file in the repository that contains information describing how a coding agent seeing it for the first time can work most efficiently.
You wi...
Add comprehensive Copilot coding agent instructions
Aug 27, 2025
IBJunior
approved these changes
Aug 27, 2025
Member
IBJunior
left a comment
There was a problem hiding this comment.
Everything is good for this first version of .github/copilot-instructions.md, it'll probably evolve with new versions.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive GitHub Copilot instructions to help coding agents work more efficiently with the slimcontext repository by providing essential context about the codebase, build process, and architecture.
- Documents the repository as a TypeScript npm library for chat history compression with a "Bring Your Own Model" approach
- Provides validated development workflow with dependency installation, build process, testing, and formatting commands
- Details project architecture including core interfaces and compression strategies with known ESLint configuration issue workaround
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
IBJunior
added a commit
that referenced
this pull request
Aug 27, 2025
* Initial plan * Add comprehensive .github/copilot-instructions.md file Co-authored-by: IBJunior <48456829+IBJunior@users.noreply.github.com> * Update .github/copilot-instructions.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update .github/copilot-instructions.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: IBJunior <48456829+IBJunior@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
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 PR adds a comprehensive
.github/copilot-instructions.mdfile to onboard the repository for use with GitHub Copilot coding agents. The instructions are designed to help coding agents work more efficiently by providing essential context about the codebase, build process, and architecture.What's included
Repository Overview: Describes slimcontext as a lightweight, model-agnostic chat history compression library using a "Bring Your Own Model" (BYOM) approach. Documents that it's a TypeScript npm library with ~24 source files targeting Node.js CommonJS modules.
Build Instructions: Provides a complete development workflow with validated commands:
Project Architecture: Details the framework-agnostic design with core interfaces (
SlimContextMessage,SlimContextChatModel,SlimContextCompressor) and two main compression strategies (trim and summarize). Maps out the directory structure and explains the role of key files.Validation Steps: Documents expected test outputs, build artifacts, and common issues with their workarounds.
Verification
All documented commands have been tested and verified to work correctly:
npm install→ successful dependency installation with automatic buildnpm run test→ 7 tests pass across 2 files as documentednpm run format:check→ code style validation passesnpm run build→ generates expected dist/ artifactsnpm run lint→ confirms documented ESLint issue exists but doesn't affect functionalityThe instructions follow the 2-page limit and focus on reducing agent exploration time by providing comprehensive context about build processes, architecture, and known issues upfront.
💡 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.