✨ Set up Copilot instructions for repository #858
Merged
+348
−0
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
Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>
Copilot
AI
changed the title
Copilot finished work on behalf of
stephentoub
October 13, 2025 18:53
stephentoub
approved these changes
Oct 13, 2025
eiriktsarpalis
approved these changes
Oct 13, 2025
|
@copilot, please address the feedback. Note that instructions should be more focused on implementing the library than they are on consuming the library. |
Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>
Addressed in commit c4db428. The instructions now focus on implementing the library with sections on:
|
Copilot finished work on behalf of
stephentoub
October 13, 2025 19:28
There was a problem hiding this comment.
We should include a session describing the key types, architectural strata and their relations that the library defines. Examples include:
- The DTO types in the
Protocolfolder - The built-in JSON-RPC implementation,
- The
ITransportabstraction, - The
McpSession,McpServer, andMcpClienttypes, - The two transport implementations provided and their invariants,
- Details on our approach to serialization, e.g. how JSON-RPC message serialization hardcode to the source generator whereas user defined types in tool calls must accept a
JsonSerializerOptions.
Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>
Added comprehensive section in commit a54c6c2 covering:
|
Copilot finished work on behalf of
stephentoub
October 13, 2025 19:40
|
@copilot, a validation leg is failing: Also, on some other PRs with copilot, it's seemingly been lazy about always building and running tests and ensuring that everything has successfully built and all tests passed before declaring success. Do we need anything in the instructions that is very explicit about that? Or should that be happening anyway? |
Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>
Copilot finished work on behalf of
stephentoub
October 13, 2025 21:23
|
@copilot, on some other PRs with copilot, it's seemingly been lazy about always building and running tests and ensuring that everything has successfully built and all tests passed before declaring success. Do we need anything in the instructions that is very explicit about that? Or should that be happening anyway? |
Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>
Added explicit guidance in commit 7ba4a5f. The instructions now include:
|
Copilot finished work on behalf of
stephentoub
October 13, 2025 22:26
stephentoub
reviewed
Oct 14, 2025
This was referenced Oct 20, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 comprehensive GitHub Copilot instructions to help contributors and Copilot generate code that aligns with the repository's conventions and best practices, with a focus on library implementation rather than consumption.
What's Changed
Added
.github/copilot-instructions.mdwith detailed guidance covering:Protocol/folderBenefits
This file will help GitHub Copilot:
The instructions are based on actual conventions found in the codebase, including
.editorconfig,Directory.Build.props, existing implementation patterns insrc/, test infrastructure intests/Common/, and architectural patterns throughout the SDK.Fixes #780
Original prompt
Fixes #780
💡 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.