-
Notifications
You must be signed in to change notification settings - Fork 27
Changes to non-org contribution policies and LFX clarifications #148
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -8,6 +8,8 @@ Here are some of the ways you can contribute: | |||||
| - [Report Security Vulnerabilities](#report-security-vulnerabilities) | ||||||
| - [File issues](#file-issues) | ||||||
| - [Find something to work on](#find-something-to-work-on) | ||||||
| - [Guidelines for First Contributions](#guidelines-for-first-contributions) | ||||||
| - [Guidelines for LFX Mentorship Program Candidates](#guidelines-for-lfx-mentorship-program-candidates) | ||||||
| - [Community Assignments](#community-assignments) | ||||||
| - [Assignment Process](#assignment-process) | ||||||
| - [Stale Assignment Policy](#stale-assignment-policy) | ||||||
|
|
@@ -54,6 +56,44 @@ Additionally, the project has a [milestone](https://github.com/kgateway-dev/kgat | |||||
|
|
||||||
| Flaky tests are a common source of issues and a good place to start contributing to the project. You can find these issues by filtering with the `Type: CI Test Flake` label. If you see a test that is failing regularly, you can leave a comment asking if someone is working on it. | ||||||
|
|
||||||
| ### Guidelines for First Contributions | ||||||
|
|
||||||
| Welcome! If this is your first time contributing to kgateway, we’re excited to have you here! | ||||||
|
|
||||||
| To help maintainers give you timely and thoughtful feedback, we have a few simple guidelines: | ||||||
|
|
||||||
| 1. **Maximum of THREE PRs at a time** | ||||||
| Non-organization members may have only **three open PRs under active review** in the `kgateway-dev/kgateway` repository at a time. | ||||||
| This helps us focus on providing constructive feedback on your contribution. The limit applies to all open PRs (including draft PRs). | ||||||
| Organization members are not subject to this limit. | ||||||
|
|
||||||
| 2. **Applying for organization membership** | ||||||
| After you have **five PRs merged** into the repository, you can apply for kgateway organization membership. This allows | ||||||
| you to open multiple PRs without being subject to the three-PR limit. See the [contributor ladder guide](CONTRIBUTOR_LADDER.md) | ||||||
| for details on roles and how to apply. | ||||||
|
|
||||||
| 3. **Not sure what to work on?** | ||||||
| A great place to start is issues labeled [`good first issue`](https://github.com/kgateway-dev/kgateway/issues?q=is%3Aissue+is%3Aopen+label%3A%22Good+First+Issue%22). | ||||||
| These issues are intentionally scoped to be approachable and are well-suited for first-time contributors. | ||||||
|
|
||||||
| ### Guidelines for LFX Mentorship Program Candidates | ||||||
|
|
||||||
| kgateway has participated in the [Linux Foundation's LFX Mentorship Program](https://lfx.linuxfoundation.org/tools/mentorship) for several cycles. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
nit / style guide: at start of sentence kgateway is capitalized |
||||||
|
|
||||||
| Candidates are expected to follow **all general contribution guidelines**, including the [Guidelines for First Contributions](#guidelines-for-first-contributions). | ||||||
|
|
||||||
| Additional expectations for LFX applicants: | ||||||
|
|
||||||
| - We _strongly_ encourage you to focus on one high-quality PR for an issue you have been assigned instead of opening | ||||||
| multiple PRs simultaneously. This ensures fair review capacity across all applicants. | ||||||
| - Please follow the community guidelines for issue assignment. **Do not self-assign issues.** Many issues require | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i would say this bullet point could even go under general guidelines somewhere above, maybe the |
||||||
| maintainer triage and scoping before they are ready to be worked on. | ||||||
| - Post your PRs in the [`#kgateway-contributors`](https://cloud-native.slack.com/archives/C09LVSV2TV3) Slack channel to get early feedback from maintainers. | ||||||
| - Not following the [AI policy](/CODE-OF-CONDUCT.md#generative-ai-policy) may result in your LFX application being dismissed. | ||||||
|
|
||||||
| Once you have five PRs merged into the repo, you may apply for organization membership, which removes the limit on open PRs. | ||||||
| See the [contributor ladder guide](CONTRIBUTOR_LADDER.md) for details on roles and how to apply. | ||||||
|
|
||||||
| ## Community Assignments | ||||||
| We welcome community contributions and encourage members to work on issues. To maintain an active and healthy development environment, we have the following policies: | ||||||
|
|
||||||
|
|
||||||
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.
maybe also mention not to grab an issue that's already assigned to someone else (although if it's evident there has been no progress for a while, it would be ok to ask if they are still working on it)