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

GSoD Project PR merge workflow #1257

Open
huan opened this issue Sep 7, 2021 · 0 comments
Open

GSoD Project PR merge workflow #1257

huan opened this issue Sep 7, 2021 · 0 comments

Comments

@huan
Copy link
Member

huan commented Sep 7, 2021

Dear GSoD'21 tech writers,

In the past 4 months, we have been working together for improving the documentation of the Wechaty website, and there are lots of efforts we have done by submitting Pull Requests (PRs). Thank you all for those great contributions to the Wechaty community!

However, those PRs have not been merged in time, it's not only because we have very limited time to review them, but also caused by we are lacking a merging process for the community.

Form my option, the best way to process Pull Request should be to review, request changes, approve and merge by the community because we trust you, who are our GSoD'21 tech writers, are professional enough to make the final merge decision based on the team effort.

That's the reason that I planned to build a PR workflow for our technical writers: (from this mailing list thread)

  1. a PR should be created by one team member
  2. approved by another team member(+1) and two volunteers (+2), so
  3. after PR has been approved by 3 reviewers, it will reach the minimum requirement of being merged
  4. many trivial PRs, like small changes, corrections, blog posts, and PRs not involving a review of their technical correctness, any technical writers who have the write permission should merge these PRs after (+3) if they believe it's ready to go, so that community can focus on important PRs, and avoid stacking of PRs.
  5. for non-trivial PRs, If the org admin has not taken any action in 1 week, then the volunteer will be authorized to take necessary actions to the PR, includes merge it or leave it to the org admin
  6. At last, we can always request changes after the PR gets merged.

I'd like to suggest that the tech writer team can start to follow this process in the following days and let's see how well it works. We can revise this process if there's any problem that needs to be fixed.

Our repo settings for merging PRs are as follows:

  1. Manage access: @wechaty/writers have been granted the Role: write
  2. Branch protection rules: Require pull request reviews before merging -> Required approving reviews: 3

At last, I'd like to encourage all of our technical writers to merge a PR for the community, whenever the PR has fulfilled the requirements, and you believe it's good to be merged.

Link to:

Thank you very much!

Huan

@huan huan changed the title Pull Request merging process for GSoD'21 technical writers GSoD Project PR merge workflow Sep 7, 2021
@huan huan pinned this issue Oct 4, 2021
@huan huan unpinned this issue Oct 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant