-
Notifications
You must be signed in to change notification settings - Fork 245
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 an issue template for maintainer onboarding #1924
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 |
---|---|---|
@@ -0,0 +1,81 @@ | ||
name: Maintainer Onboarding | ||
description: Onboarding checklist for maintainers | ||
title: "Onboard <GitHub handle> as <SIG/WG FOO> maintainer" | ||
labels: area/onboarding | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
This issue should be submitted by an existing maintainer of the affected SIG | ||
- id: sig | ||
type: input | ||
attributes: | ||
label: "SIG name" | ||
placeholder: "SIG example" | ||
validations: | ||
required: true | ||
- id: maintainers_group | ||
type: input | ||
attributes: | ||
label: "maintainers team" | ||
placeholder: "@opentelemetry/<sig-name>-maintainers" | ||
description: Tag the maintainers group. If unsure, you can [look groups up](https://github.com/orgs/open-telemetry/teams?query=maintainers) | ||
validations: | ||
required: true | ||
- id: github_handle | ||
type: input | ||
attributes: | ||
label: "Github handle of the new maintainer candidate" | ||
placeholder: "@example" | ||
validations: | ||
required: true | ||
- id: requirements | ||
type: checkboxes | ||
attributes: | ||
label: Requirements | ||
description: Before submitting | ||
options: | ||
- label: Are you (submitter of this issue) a maintainer of the affected SIG? | ||
required: true | ||
- label: Is the maintainer candidate a member of the OpenTelemetry GitHub organization already? | ||
required: true | ||
- id: election | ||
type: checkboxes | ||
attributes: | ||
label: Maintainer Election | ||
description: | | ||
Unless stated otherwise in a SIG charter ratified by the Technical Committee, all existing maintainers are asked to vote, | ||
if the candidate should be added to their group of maintainers. They vote by commenting "I support" or "I do not support" on this issue. | ||
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. The way we typically do this on the Collector SIG is to first have some discussion happen privately and then we make this public on a PR. Should we explicitly recognize this? |
||
The election is over, when a majority of the maintainers have voted. If the majority have voted in favour of the candidate, the candidate | ||
can accept (or decline) the vote by commenting "I accept" or "I decline". If the candidate has not been elected, the issue can be closed. | ||
options: | ||
- label: Has the candidate been elected? | ||
- label: Has the candidate accepted? | ||
- id: onboarding | ||
type: checkboxes | ||
attributes: | ||
label: Maintainer Onboarding Tasks | ||
description: | | ||
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. Should this mention that these are to be done by a current maintainer? 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. Yeah, this needs to be clearer |
||
After the maintainer has been elected, the following check list helps to verify that the maintainer has everything needed | ||
to fullfil their responsibility. | ||
options: | ||
- label: Added to the `@opentelemetry/<sig-name>-maintainers` GitHub group | ||
- label: Added to `#otel-maintainers` slack channel | ||
- label: Added to the `maintainers` section in the SIGs repositories `README.md` | ||
- label: Added to [opentelemetry-calendar-contributors Google Group](https://groups.google.com/g/opentelemetry-calendar-contributors) | ||
- label: Added to any other groups, slack channels or resources that SIG maintainers require | ||
- label: Invited to SIG meetings and Maintainer meeting. | ||
- id: tasks | ||
type: checkboxes | ||
attributes: | ||
label: Prerequisites for new maintainer | ||
description: | | ||
The maintainer is asked to review the following checklist, fullfil the items and check them off. When all items of this list are completed, this issue can be closed | ||
options: | ||
- label: Completed all **Maintainer Onboarding Tasks** (see above) | ||
- label: Reviewed the [Code of Conduct](./code-of-conduct.md) | ||
- label: Reviewed [requirements, responsibilites and privileges](./community-membership.md#maintainer) | ||
- label: Reviewed [mission, vision, values](./mission-vision-values.md) | ||
- label: Reviewed all SIG specific documents that are relevant for a maintainer | ||
- label: Scheduled a introductory call (30-60 minutes) with a GC member | ||
- label: Completed the [Inclusive Open Source Community Orientation course](https://training.linuxfoundation.org/training/inclusive-open-source-community-orientation-lfc102/) |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -227,18 +227,22 @@ | |||||
### Becoming a Maintainer | ||||||
|
||||||
Unless stated otherwise in a SIG charter ratified by the Technical Committee, | ||||||
a new maintainer is elected by vote of the existing maintainers of the SIG. | ||||||
The vote is officially started when a pull request to add a new maintainer | ||||||
is opened, and ends when the pull request is merged. The pull request may be | ||||||
merged when the following conditions are met: | ||||||
|
||||||
- The person being nominated has accepted the nomination by approving the pull request | ||||||
- All maintainers have approved the pull request OR a majority of maintainers | ||||||
have approved the pull request and no maintainer has objected by requesting | ||||||
changes on the pull request. In the case that all maintainers have not given | ||||||
approval, the pull request should stay open for a minimum of 5 days before merging. | ||||||
|
||||||
The nominee is considered a maintainer after the pull request is merged. | ||||||
a new maintainer is elected by vote of thee existing maintainers of the SIG. | ||||||
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
|
||||||
The vote is officially started when an | ||||||
[issue is created](https://github.com/open-telemetry/community/issues/new?assignees=&labels=area%2Fonboarding&template=maintainer-onboarding.yml&title=Maintainer+Onboarding%3A+%3CGH_USERNAME%3E) | ||||||
to add the nominee as a new maintainer. All existing maintainers of the SIG | ||||||
are asked to vote by commenting "I support" or "I do not support" on this issue. | ||||||
The election is over, when a majority of the maintainers have voted: | ||||||
|
||||||
- If the majority have voted in favour of the nominee, the candidate accepts | ||||||
(or declines) the vote by commenting "I accept" or "I decline". The nominee is | ||||||
considered a maintainer immediatly after they accepted. | ||||||
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
|
||||||
- If the majority have voted against the nominee becoming a maintainer, the | ||||||
issue can be closed and the nominee has not been elected. | ||||||
|
||||||
In the case that no majority in favour or against the nominee can be accomplished | ||||||
within 5 days, a minority vote sufficies. | ||||||
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
|
||||||
|
||||||
|
||||||
#### Self-nomination is encouraged | ||||||
|
||||||
|
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.
Should this point back to the
Becoming a Maintainer
part of the docs rather than repeating the election process?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.
good point! Let me fix that.