diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 00000000..4e14182b --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,27 @@ +# GitHub Copilot Instructions for Wassette + +This file provides specific instructions for GitHub Copilot when working on the Wassette project. + +## Pull Request Descriptions + +**Keep PR descriptions concise and focused:** +- Describe your changes in **at most 3 sentences** +- Focus on the what and why, not implementation details +- If the PR breaks public-facing APIs, use one or two sentences to describe what is broken and how users should adapt + +**Example of a good PR description:** +``` +This PR adds instrumentation to the MCP server runtime. It enables performance monitoring and debugging of tool execution. The changes are backward compatible with existing configurations. +``` + +**Example for breaking changes:** +``` +This PR refactors the component registry API to support versioning. The `ComponentRegistry::register()` method now requires a version parameter. Existing code should be updated to pass a version string as the second argument. +``` + +## Additional Guidelines + +For comprehensive development guidelines, see: +- **[AGENTS.md](../AGENTS.md)** - Complete AI agent development guide +- **[.github/instructions/rust.instructions.md](.github/instructions/rust.instructions.md)** - Rust-specific instructions +- **[.github/instructions/docs.instructions.md](.github/instructions/docs.instructions.md)** - Documentation guidelines diff --git a/AGENTS.md b/AGENTS.md index ab8c8d00..32531d10 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -350,6 +350,18 @@ When making documentation changes that affect visual presentation: Most contributions require you to agree to a Contributor License Agreement (CLA). When you submit a pull request, a CLA-bot will determine if you need to provide a CLA. See [CONTRIBUTING.md](./CONTRIBUTING.md) for details. +### Pull Request Description Guidelines + +**Keep PR descriptions concise and focused:** +- Describe your changes in **at most 3 sentences** +- Focus on the what and why, not implementation details +- If the PR breaks public-facing APIs, use one or two sentences to describe what is broken and how users should adapt + +**Example of a good PR description:** +``` +This PR adds instrumentation to the MCP server runtime. It enables performance monitoring and debugging of tool execution. The changes are backward compatible with existing configurations. +``` + ### Code of Conduct This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com).