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

Add PR template for moving up the contributor ladder #190

Closed
wants to merge 1 commit into from

Conversation

xmulligan
Copy link
Member

PR template for people requesting to become org members and reviewers to clarify what information is helpful when opening the PR

As discussed in #180 (comment)

PR template for people requesting to become org members and reviewers to clarify what information is helpful when opening the PR

As discussed in #180 (comment)

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

@joestringer joestringer left a comment

Choose a reason for hiding this comment

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

The content looks good to me, though I wonder if it's worth trying to format this a bit more interactively, closer to the Cilium bug report template. When people unfamiliar with a template interact with it, sometimes they end up just leaving the templated text in the issue because they don't understand what they are expected to do with the templated text, and the result is that reviewers have to go back and ask the person to update their response to properly address the questions we are looking to be answered in the template. I think we've had pretty good experience with the UX from the Cilium bug report template.

@@ -0,0 +1,24 @@
# Moving up the [Contributor Ladder](https://github.com/cilium/community/blob/main/CONTRIBUTOR-LADDER.md)

```
Copy link
Member

Choose a reason for hiding this comment

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

Looking at the rendered version, this verbatim formatting is causing the links below to not be rendered correctly.

xmulligan added a commit that referenced this pull request Jan 22, 2025
PR template for people requesting to become org members and reviewers to clarify what information is helpful when opening the PR

Replaces #190 with a fillable template


Signed-off-by: Bill Mulligan <[email protected]>
@xmulligan
Copy link
Member Author

closing in favor of #191

@xmulligan xmulligan closed this Jan 22, 2025
@xmulligan xmulligan deleted the xmulligan-patch-4 branch January 22, 2025 13:36
joestringer pushed a commit to joestringer/cilium-community that referenced this pull request Jan 23, 2025
PR template for people requesting to become org members and reviewers to clarify what information is helpful when opening the PR

Replaces cilium#190 with a fillable template


Signed-off-by: Bill Mulligan <[email protected]>
xmulligan added a commit that referenced this pull request Jan 24, 2025
PR template for people requesting to become org members and reviewers to clarify what information is helpful when opening the PR

Supersedes #190 and #191

I’ve considered various approaches to formatting this but landed on the current one for simplicity. Initially, I thought about making this an issue template, but requiring contributors to open an issue before a PR felt unnecessarily complex and could lead to confusion.

For reference, #190 included an additional top section that I’ve since removed, as it added extra wording without providing new information beyond what’s already covered in the ladder.

I also explored creating multiple templates, but that seemed confusing too—contributors would need to know the correct URLs for each template. This solution isn’t perfect since it applies to the entire repository, including SIGs and sub-repositories. However, I expect external contributors to interact with those less frequently, and internal contributors will likely bypass the template where necessary.

Signed-off-by: Bill Mulligan <[email protected]>
joestringer pushed a commit that referenced this pull request Jan 27, 2025
PR template for people requesting to become org members and reviewers to clarify what information is helpful when opening the PR

Supersedes #190 and #191

I’ve considered various approaches to formatting this but landed on the current one for simplicity. Initially, I thought about making this an issue template, but requiring contributors to open an issue before a PR felt unnecessarily complex and could lead to confusion.

For reference, #190 included an additional top section that I’ve since removed, as it added extra wording without providing new information beyond what’s already covered in the ladder.

I also explored creating multiple templates, but that seemed confusing too—contributors would need to know the correct URLs for each template. This solution isn’t perfect since it applies to the entire repository, including SIGs and sub-repositories. However, I expect external contributors to interact with those less frequently, and internal contributors will likely bypass the template where necessary.

Signed-off-by: Bill Mulligan <[email protected]>
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