Skip to content

PHPLIB-1726: Add copilot instructions for reviews #1782

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
wants to merge 1 commit into
base: v1.21
Choose a base branch
from
Draft

PHPLIB-1726: Add copilot instructions for reviews #1782

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
47 changes: 47 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,47 @@
# GitHub Copilot Instructions

## Code Review Guidelines

### Review Focus
- **Do not repeat or paraphrase the PR description**
- Only highlight changes or notable information that was omitted from the description
- Focus on code quality, potential issues, and improvements not mentioned in the PR

### PHP Version and Type Requirements
- Code must support **PHP 8.1 and newer**
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we ask it to check the PHP constraints in composer.json so that we don't have to maintain the version number here?

Suggested change
- Code must support **PHP 8.1 and newer**
- The minimum PHP version supported is in the `./composer.json`. Code must support **this version and newer**

- Use **full type declarations** wherever possible
- Leverage PHP 8.1+ features when appropriate (enums, readonly properties, intersection types, etc.)
- Use **PHPDoc blocks** to supplement native types where PHP limitations exist:
- Generics: `@template T`, `@param Collection<T>`, `@return T`
- Union types for complex scenarios
- Array shapes: `@param array{name: string, age: int}`
- More specific types than native PHP allows

### Code Quality Standards
- Ensure all public methods have complete type hints
- Private/protected methods should also be fully typed
- Use strict scalar type declarations (`declare(strict_types=1)`)
- Prefer constructor property promotion when applicable
- Use named arguments for better readability in complex method calls
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Use named arguments for better readability in complex method calls
- Use named arguments for better readability in complex method calls to functions inside this package


### MongoDB Library Specific
- Check for proper error handling patterns
- Ensure BSON type handling is correct
- Verify connection pool and client usage follows best practices
- Look for potential performance implications in database operations
- Ensure proper use of type maps and codecs

### What to Flag in Reviews
- Missing type declarations that could be added
- Opportunities to use newer PHP features
- Code that might not work with the minimum PHP 8.1 requirement
- Missing PHPDoc for complex types or generics
- Inconsistent coding standards
- Potential performance or security issues not mentioned in PR description
- Breaking changes that weren't highlighted
- Documentation that needs updating due to code changes

### What NOT to Comment On
- Changes that are clearly explained in the PR description
- Style preferences that are already covered by existing linting tools
- Minor formatting issues that automated tools should catch