-
Notifications
You must be signed in to change notification settings - Fork 27
chore: add OWNERS.md file to match repo permissions #233
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.
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
Conversation
Signed-off-by: Jared Watts <[email protected]>
📝 WalkthroughWalkthroughA new OWNERS.md documentation file has been introduced that defines the repository's maintainers, references governance guidelines, and lists contributor information including newly added maintainers Ezgi Demirel and Steven Borrelli, mirroring the crossplane/crossplane repository's structure. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes This is a straightforward documentation addition with no code logic or complex structure—primarily requires verifying maintainer information accuracy and governance reference consistency. Pre-merge checks✅ Passed checks (3 passed)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
OWNERS.md (2)
11-14: Consider wrapping line 11 to maintain 100-character consistency.Line 11 runs approximately 148 characters, exceeding the 100-column guideline for Markdown files. While the embedded link is long, you could wrap it as follows without sacrificing readability:
-The Maintainers mirror the [crossplane/crossplane OWNERS](https://github.com/crossplane/crossplane/blob/main/OWNERS.md) with the following changes: +The Maintainers mirror the [crossplane/crossplane OWNERS](https://github.com/crossplane/crossplane/blob/main/OWNERS.md) +with the following changes:This aligns with the document's otherwise clean formatting.
24-24: Add a newline at the end of the file.Files should conventionally end with a newline character. Please add one after line 24.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
OWNERS.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.md
⚙️ CodeRabbit configuration file
**/*.md: Ensure Markdown files are wrapped at 100 columns for consistency and
readability. Lines can be longer if it makes links more readable, but
otherwise should wrap at 100 characters. Check for proper heading
structure, clear language, and that documentation is helpful for users.
Files:
OWNERS.md
🔍 Remote MCP
Additional Context for PR #233 Review
Governance Framework
Each repository in the Crossplane organizations can have different teams of maintainers with permissions, with adding and removing maintainers being the responsibility of the existing maintainer team for that repository.
OWNERS.md Purpose
Each repository in the Crossplane organization is expected to list their repository maintainers and reviewers in their own OWNERS.md file. The current list of maintainers for each repository is published and updated in each repo's OWNERS.md file.
Maintainer Requirements
To verify the PR adds appropriate maintainers, note that becoming a maintainer requires demonstrating leadership in the community and domain expertise in the repository's area of focus, along with willingness to contribute beyond organizational interests. Maintainers are expected to spend at least 25% of their time working on Crossplane (~1.25 business days per week).
Repository Context
The function-sdk-go repository is the Go SDK for composition functions and follows the same contributing guidelines as Crossplane.
Key Considerations for Review
- Verify the newly added maintainers (Ezgi Demirel and Steven Borrelli) meet the governance requirements for maintainers
- Confirm the OWNERS.md structure aligns with other Crossplane repositories (like provider-template and crossplane-runtime)
- Ensure the file properly references GOVERNANCE.md for guidelines and maintainer responsibilities
[::web_search::]
🔇 Additional comments (2)
OWNERS.md (2)
1-9: Nice work documenting governance context and maintainers!The OWNERS.md file is well-structured, clearly references Crossplane's GOVERNANCE.md guidelines, and provides helpful context about how this repository's maintainers align with the crossplane/crossplane repository. The introduction effectively explains the file's purpose for newcomers to the project.
16-24: Maintainers list is clear and well-formatted.The maintainers section is consistent, comprehensive, and includes all relevant contact information for each person. The addition of Ezgi Demirel and Steven Borrelli is clearly documented in both the summary section and the full list, making it easy for contributors to identify the team.
Description of your changes
This PR adds an OWNERS.md file to list the current maintainers. This file matches what is in the github permissions.
I have:
make reviewableto ensure this PR is ready for review.