Skip to content

Add PR description length guidelines to agent instructions #582

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.

Sign up for GitHub

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

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add PR description length guidelines to agent instructions #582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e79c0d
Initial plan
Copilot Nov 21, 2025
496da6e
Add PR description guidelines to AGENTS.md and copilot-instructions.md
Copilot Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .github/copilot-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
12 changes: 12 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 [[email protected]](mailto:[email protected]).
Expand Down
Loading