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

docs/design: update proposal workflow #23999

Merged
merged 24 commits into from
Apr 22, 2021

Conversation

tisonkun
Copy link
Contributor

@tisonkun tisonkun commented Apr 14, 2021

What problem does this PR solve?

Issue Number: close pingcap/community#431

Problem Summary:

We'd better clarify our proposal workflow so that contributors can follow the lightweight workflow proposing features against TiDB projects, as well as improve major changes visibility.

It mainly follow tikv/rfcs which already satisfies most of our development requirement. And it is not a new workflow but formalizes best practice we already took but not yet publicly documented.

Details in files changed. Please comment against the diff.

Release note

  • No release note

@ti-chi-bot ti-chi-bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Apr 14, 2021
docs/design/README.md Outdated Show resolved Hide resolved
docs/design/README.md Outdated Show resolved Hide resolved
docs/design/README.md Outdated Show resolved Hide resolved
docs/design/README.md Outdated Show resolved Hide resolved
docs/design/TEMPLATE.md Outdated Show resolved Hide resolved

Although there is no single way to prepare for submitting a design document, it is generally a good idea to pursue feedback from other project developers beforehand, to ascertain that the design document may be desirable; having a consistent impact on the project requires concerted effort toward consensus-building.

The most common preparations for writing and submitting an design document for now is [creating a disucss issue](https://github.com/pingcap/tidb/issues/new/choose), which is going to be converted into a tracking issue of the design implementation.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We should leverage GitHub Discussion / Mailing List / Forum / Slack later when we have an active and clear communication way. I can image the discuss issue would quickly vanish from the first page of our issue view. But we don't have a better open way yet.

docs/design/TEMPLATE.md Outdated Show resolved Hide resolved
Copy link
Member

@zz-jason zz-jason left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@zz-jason zz-jason left a comment

Choose a reason for hiding this comment

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

/lgtm

@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Apr 21, 2021
@tisonkun
Copy link
Contributor Author

/cc @bb7133

@ti-chi-bot ti-chi-bot requested a review from bb7133 April 21, 2021 08:36
docs/design/TEMPLATE.md Outdated Show resolved Hide resolved
docs/design/TEMPLATE.md Outdated Show resolved Hide resolved
docs/design/README.md Outdated Show resolved Hide resolved
docs/design/README.md Outdated Show resolved Hide resolved
docs/design/README.md Outdated Show resolved Hide resolved
docs/design/README.md Outdated Show resolved Hide resolved
tisonkun and others added 2 commits April 21, 2021 18:06
Co-authored-by: bb7133 <bb7133@gmail.com>
Co-authored-by: bb7133 <bb7133@gmail.com>
tisonkun and others added 4 commits April 21, 2021 18:06
Co-authored-by: bb7133 <bb7133@gmail.com>
Co-authored-by: bb7133 <bb7133@gmail.com>
Co-authored-by: bb7133 <bb7133@gmail.com>
Co-authored-by: bb7133 <bb7133@gmail.com>
@tisonkun
Copy link
Contributor Author

@bb7133 thanks for your review! updated.

@bb7133
Copy link
Member

bb7133 commented Apr 22, 2021

/lgtm

@ti-chi-bot
Copy link
Member

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • bb7133
  • zz-jason

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

The full list of commands accepted by this bot can be found here.

Reviewer can indicate their review by writing /lgtm in a comment.
Reviewer can cancel approval by writing /lgtm cancel in a comment.

@ti-chi-bot ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Apr 22, 2021
@bb7133
Copy link
Member

bb7133 commented Apr 22, 2021

/merge

@ti-chi-bot
Copy link
Member

This pull request has been accepted and is ready to merge.

Commit hash: 6bf30ab

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Apr 22, 2021
@ti-chi-bot
Copy link
Member

@tisonkun: Your PR was out of date, I have automatically updated it for you.

At the same time I will also trigger all tests for you:

/run-all-tests

If the CI test fails, you just re-trigger the test that failed and the bot will merge the PR for you after the CI passes.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the ti-community-infra/tichi repository.

@ti-chi-bot
Copy link
Member

/run-all-tests

This bot automatically retries jobs that failed on can merge PRs (send feedback to hi-rustin).

Silence the bot with the /merge cancel comment for consistent failures.

@ti-chi-bot ti-chi-bot merged commit 6889ab4 into pingcap:master Apr 22, 2021
@tisonkun tisonkun deleted the proposal-workflow branch April 22, 2021 13:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/L Denotes a PR that changes 100-499 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

TiDB Design Document Workflow
4 participants