Skip to content

Documentation: describe onboarding process#15911

Merged
mitake merged 1 commit intoetcd-io:mainfrom
mitake:onboarding
May 25, 2023
Merged

Documentation: describe onboarding process#15911
mitake merged 1 commit intoetcd-io:mainfrom
mitake:onboarding

Conversation

@mitake
Copy link
Copy Markdown
Contributor

@mitake mitake commented May 16, 2023

Please read https://github.com/etcd-io/etcd/blob/main/CONTRIBUTING.md#contribution-flow.

cc @serathius @ahrtr @spzala @ptabor

I think it's good to update onboarding process for members and reviewers too.

Comment thread Documentation/contributor-guide/community-membership.md Outdated
@mitake mitake marked this pull request as draft May 16, 2023 13:18
@mitake
Copy link
Copy Markdown
Contributor Author

mitake commented May 16, 2023

I'd like to have comments on below points:

  • Requirements has some descriptions which duplicate with onboarding process, so might be good to clean up for avoiding duplicated descriptions.
  • All members, reviewers and maintainers need to enable github 2FA. Should we have a common onboarding process for all members?

Comment thread Documentation/contributor-guide/community-membership.md Outdated
Comment thread Documentation/contributor-guide/community-membership.md Outdated

### Onboarding process

- Open a PR and add an entry to the [MAINTAINERS] file.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

As maintainer requires a supermajority I would make an exception that this should be done privatly.
I would start from asking two maintainers to become a sponsor and sending an email with candidacy to [etcd-maintainers-private@googlegroups.com] asking for a vote.

Existing maintainers would then vote privatly (move discussion to bbc) allowing a full transparency. After votes are cast one of maintainers would respond with result to the original email. Either positive or negative with feedback for suggested improvement.

If result is positive, candidate can file a public PR

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

+1 Basically makes sense to me.

If result is positive, candidate can file a public PR

Any of the existing maintainers can also raise a public PR after there is a agreement;

Copy link
Copy Markdown
Member

@serathius serathius May 17, 2023

Choose a reason for hiding this comment

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

Any of the existing maintainers can also raise a public PR after there is a agreement;

Sure, however I would like to follow K8s and have the process driven by candidate so it doesn't get stuck on maintainer and the candidate doesn't need to wait for creating the PR.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I think the steps are good, will describe in the file. But IIUC only maintainers can send emails to [etcd-maintainers-private@googlegroups.com], so a candidate should use [etcd-maintainers@googlegroups.com]?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think everyone can send emails to etcd-maintainers-private@googlegroups.com, but only maintainers can read them.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I checked the config and that’s true, let me update the description.

Comment thread Documentation/contributor-guide/community-membership.md Outdated
Comment thread Documentation/contributor-guide/community-membership.md Outdated
Copy link
Copy Markdown
Member

@spzala spzala left a comment

Choose a reason for hiding this comment

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

Thanks @mitake !! I agree with comments from @serathius
Also, I think some duplication, of couple of sentences, among different sections is usually fine as it helps thoroughly review a specific section.


### Onboarding process

- Open a PR and add an entry to the [MAINTAINERS] file.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@mitake mitake force-pushed the onboarding branch 2 times, most recently from ebf5367 to 21ed891 Compare May 18, 2023 14:35
Comment thread Documentation/contributor-guide/community-membership.md Outdated
Comment thread Documentation/contributor-guide/community-membership.md Outdated
@serathius
Copy link
Copy Markdown
Member

I think you picked up my old commit. Please remove it, if you need help with that let me know.

@mitake
Copy link
Copy Markdown
Contributor Author

mitake commented May 23, 2023

@serathius sorry I rebased on the latest main and removed the commit from this branch.

@mitake mitake force-pushed the onboarding branch 2 times, most recently from 123bd4c to 0e1e96c Compare May 23, 2023 13:28
@ahrtr
Copy link
Copy Markdown
Member

ahrtr commented May 23, 2023

@mitake Please mark this PR as Ready for review once it's ready. Overall looks good to me!

@serathius
Copy link
Copy Markdown
Member

Also looks good to me, I think it would be reasonable to mention the secrets even if we don't want immediately migrate them to shared storage. We could leave a TODO :P

@mitake mitake marked this pull request as ready for review May 24, 2023 13:34
@mitake
Copy link
Copy Markdown
Contributor Author

mitake commented May 24, 2023

@ahrtr @serathius thanks for checking, I marked this PR as ready to be reviewed. I added a description like this to GCP project line: note that this GCP project will be used for shared secret management for various services, wdyt?

Comment thread Documentation/contributor-guide/community-membership.md Outdated
Signed-off-by: Hitoshi Mitake <h.mitake@gmail.com>
Co-authored-by: Marek Siarkowicz <siarkowicz@google.com>
@serathius
Copy link
Copy Markdown
Member

Awesome work! Thanks for helping new maintainers onboard!

@mitake
Copy link
Copy Markdown
Contributor Author

mitake commented May 25, 2023

@serathius Thanks for improving the descriptions! Let me merge.

@mitake mitake merged commit 09b8673 into etcd-io:main May 25, 2023
@mitake mitake deleted the onboarding branch May 25, 2023 14:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants