Skip to content
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

Move Contributing to a separate file #510

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

xmulligan
Copy link
Member

Moving the developing and contributing sections out of the main README into a separate file like most projects

Moving the contributing section into its own separate file

Signed-off-by: Bill Mulligan <[email protected]>
@xmulligan xmulligan requested a review from a team as a code owner March 21, 2025 14:30
@xmulligan xmulligan requested review from brb and removed request for a team March 21, 2025 14:30

Cilium has a well-defined [contributor ladder](https://github.com/cilium/community/blob/main/CONTRIBUTOR-LADDER.md) to help community members grow both responsibilities and privileges in the ecosystem. This ladder outlines the path from an occasional contributor to a committer, detailing expectations at each stage. Most contributors start at the community level and progress as they become more engaged in the project. We encourage you to take an active role, and the community is here to support you on this journey.

Becoming a [Cilium organization member](https://github.com/cilium/community/blob/main/CONTRIBUTOR-LADDER.md#organization-member) grants you additional privileges, such as the ability to trigger CI runs. If you're contributing regularly to `pwru`, consider joining the [pwru team](https://github.com/cilium/community/blob/main/ladder/teams/pwru.yaml) to help review code and accelerate development. Your contributions play a vital role in improving the project, and we'd love to have you more involved!
Copy link
Member

Choose a reason for hiding this comment

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

The "trigger CI runs" aspect is not relevant to pwru, pwru has a simpler CI that just runs when you submit a PR.

Copy link
Member Author

Choose a reason for hiding this comment

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

I've made some suggestions about making it broader about benefits across the project ecosystem. What do you think?

CONTRIBUTING.md Outdated

## Development Guidelines

- Follow Cilium's general [Developer Guide](https://docs.cilium.io/en/stable/contributing/development/) for coding standards and best practices.
Copy link
Member

Choose a reason for hiding this comment

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

The developer guide link here has a lot of content, and it is all tailored towards developing on cilium/cilium. I'm not sure whether new contributors for pwru without cilium background would have a good chance of finding the relevant info here. I agree in principle the coding standards & best practices are likely well aligned between the subprojects, but I'm not sure which parts of the linked contributing guide are relevant for pwru.

Copy link
Member

Choose a reason for hiding this comment

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

Something like https://docs.cilium.io/en/stable/contributing/development/contributing_guide/#how-to-contribute is probably more practical, but there's still a few steps that aren't necessary for pwru, such as steps 7, 9-13.

Copy link
Member

Choose a reason for hiding this comment

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

Overall the ideal is probably more that we enforce the "coding standards and best practices" via GitHub workflows so they apply automatically rather than just documenting them and hoping contributors will follow. But that would involve more work on the GHA side in this repo. I'm thinking stuff like adding golangci-lint to lint for common errors for instance.

CONTRIBUTING.md Outdated
## Development Guidelines

- Follow Cilium's general [Developer Guide](https://docs.cilium.io/en/stable/contributing/development/) for coding standards and best practices.
- Before submitting a pull request, review the [Code Review Guidelines](https://docs.cilium.io/en/stable/contributing/code-reviews/).
Copy link
Member

Choose a reason for hiding this comment

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

Signed-off-by: Bill Mulligan <[email protected]>

## Contributor Ladder

Cilium has a well-defined [contributor ladder](https://github.com/cilium/community/blob/main/CONTRIBUTOR-LADDER.md) to help community members grow both responsibilities and privileges in the ecosystem. This ladder outlines the path from an occasional contributor to a committer, detailing expectations at each stage. Most contributors start at the community level and progress as they become more engaged in the project. We encourage you to take an active role, and the community is here to support you on this journey.
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
Cilium has a well-defined [contributor ladder](https://github.com/cilium/community/blob/main/CONTRIBUTOR-LADDER.md) to help community members grow both responsibilities and privileges in the ecosystem. This ladder outlines the path from an occasional contributor to a committer, detailing expectations at each stage. Most contributors start at the community level and progress as they become more engaged in the project. We encourage you to take an active role, and the community is here to support you on this journey.
The Cilium project has a well-defined [contributor ladder](https://github.com/cilium/community/blob/main/CONTRIBUTOR-LADDER.md) to help community members grow both responsibilities and privileges in the project ecosystem. This ladder outlines the path from an occasional contributor to a committer, detailing expectations at each stage. Most contributors start at the community level in a sub-project and progress as they become more engaged in the project ecosystem. We encourage you to take an active role, and the community is here to support you on this journey.


Cilium has a well-defined [contributor ladder](https://github.com/cilium/community/blob/main/CONTRIBUTOR-LADDER.md) to help community members grow both responsibilities and privileges in the ecosystem. This ladder outlines the path from an occasional contributor to a committer, detailing expectations at each stage. Most contributors start at the community level and progress as they become more engaged in the project. We encourage you to take an active role, and the community is here to support you on this journey.

Becoming a [Cilium organization member](https://github.com/cilium/community/blob/main/CONTRIBUTOR-LADDER.md#organization-member) grants you additional privileges, such as the ability to trigger CI runs. If you're contributing regularly to `pwru`, consider joining the [pwru team](https://github.com/cilium/community/blob/main/ladder/teams/pwru.yaml) to help review code and accelerate development. Your contributions play a vital role in improving the project, and we'd love to have you more involved!
Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
Becoming a [Cilium organization member](https://github.com/cilium/community/blob/main/CONTRIBUTOR-LADDER.md#organization-member) grants you additional privileges, such as the ability to trigger CI runs. If you're contributing regularly to `pwru`, consider joining the [pwru team](https://github.com/cilium/community/blob/main/ladder/teams/pwru.yaml) to help review code and accelerate development. Your contributions play a vital role in improving the project, and we'd love to have you more involved!
Becoming a [Cilium organization member](https://github.com/cilium/community/blob/main/CONTRIBUTOR-LADDER.md#organization-member) grants you additional privileges across the project ecosystem, such as the ability to leave reviews on a PR or trigger CI runs. If you're contributing regularly to `pwru`, consider joining the [pwru team](https://github.com/cilium/community/blob/main/ladder/teams/pwru.yaml) to help review code and accelerate development. Your contributions play a vital role in improving the project, and we'd love to have you more involved!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants