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.

Sign up for GitHub

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

Jump to bottom

README: update contributing guide #20262

Merged
merged 7 commits into from
Sep 29, 2020
Merged

README: update contributing guide #20262

merged 7 commits into from
Sep 29, 2020

Conversation

dcalvin
Copy link
Contributor

@dcalvin dcalvin commented Sep 28, 2020 •
edited by jackysp
Loading

What problem does this PR solve?

Issue Number: close #xxx

Problem Summary:

What is changed and how it works?

Proposal: xxx

What's Changed: Moved contributing guide back to tidb repo, refactored it with better structure, and updated it with Hacktoberfest info

How it Works:

Related changes

  • PR to update pingcap/docs/pingcap/docs-cn:
  • Need to cherry-pick to the release branch

Check List

Tests

  • Unit test
  • Integration test
  • Manual test (add detailed scripts or steps below)
  • No code

Side effects

  • Performance regression
    • Consumes more CPU
    • Consumes more MEM
  • Breaking backward compatibility

Release note

  • No release note

@sre-bot
Copy link
Contributor

sre-bot commented Sep 28, 2020

No release note, Please follow https://github.com/pingcap/community/blob/master/contributors/release-note-checker.md

@dcalvin dcalvin requested a review from zz-jason September 28, 2020 03:41
@sre-bot
Copy link
Contributor

sre-bot commented Sep 28, 2020

Please follow PR Title Format:

  • pkg [, pkg2, pkg3]: what's changed

Or if the count of mainly changed packages are more than 3, use

  • *: what's changed

@dcalvin dcalvin requested a review from AndreMouche September 28, 2020 03:42
winkyao
winkyao reviewed Sep 28, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
winkyao
winkyao reviewed Sep 28, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
@winkyao
Copy link
Contributor

winkyao commented Sep 28, 2020

Rest LGTM

@sre-bot
Copy link
Contributor

sre-bot commented Sep 28, 2020

Please follow PR Title Format:

  • pkg [, pkg2, pkg3]: what's changed

Or if the count of mainly changed packages are more than 3, use

  • *: what's changed

@sre-bot
Copy link
Contributor

sre-bot commented Sep 28, 2020

No release note, Please follow https://github.com/pingcap/community/blob/master/contributors/release-note-checker.md

winkyao
winkyao previously approved these changes Sep 29, 2020
View reviewed changes
Copy link
Contributor

@winkyao winkyao 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-srebot ti-srebot added the status/LGT1 Indicates that a PR has LGTM 1. label Sep 29, 2020
@sre-bot
Copy link
Contributor

sre-bot commented Sep 29, 2020

Please follow PR Title Format:

  • pkg [, pkg2, pkg3]: what's changed

Or if the count of mainly changed packages are more than 3, use

  • *: what's changed

@sre-bot
Copy link
Contributor

sre-bot commented Sep 29, 2020

No release note, Please follow https://github.com/pingcap/community/blob/master/contributors/release-note-checker.md

@winkyao winkyao changed the title update contributing guide README: update contributing guide Sep 29, 2020
@AndreMouche AndreMouche requested a review from a team September 29, 2020 02:51
AndreMouche
AndreMouche reviewed Sep 29, 2020
View reviewed changes
CONTRIBUTING.md Outdated

| Component | Description | Issue Link |
|---|---|---|
| TiDB Dashboard | A Web UI for monitoring, diagnosing and managing the TiDB cluster. | <https://github.com/pingcap-incubator/tidb-dashboard/issues?q=is%3Aopen+is%3Aissue+label%3AHacktoberfest> |
Copy link
Contributor

Choose a reason for hiding this comment

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

I think to move the chapter of ## Hacktoberfest to the community repo will be better?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It will be obscured if we put in the community repo. This is a temporary update that we want to expose as much as possible. So this is the place.

Copy link
Member

Choose a reason for hiding this comment

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

we also have other active community events, should we put them here as well?

@AndreMouche
Copy link
Contributor

@pingcap/tidb-master-maintainers PTAL, thanks

@sre-bot
Copy link
Contributor

sre-bot commented Sep 29, 2020

No release note, Please follow https://github.com/pingcap/community/blob/master/contributors/release-note-checker.md

zz-jason
zz-jason reviewed Sep 29, 2020
View reviewed changes
CONTRIBUTING.md Outdated
| Component | Description | Issue Link |
|---|---|---|
| TiDB Dashboard | A Web UI for monitoring, diagnosing and managing the TiDB cluster. | <https://github.com/pingcap-incubator/tidb-dashboard/issues?q=is%3Aopen+is%3Aissue+label%3AHacktoberfest> |
| | | |
Copy link
Member

Choose a reason for hiding this comment

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

how about removing the empty table?

zz-jason
zz-jason reviewed Sep 29, 2020
View reviewed changes
CONTRIBUTING.md Outdated
<!-- TOC -->

- [Contribution Guide](#contribution-guide)
- [Hacktoberfest](#hacktoberfest)
Copy link
Member

Choose a reason for hiding this comment

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

maybe we can replace it with community events?

tiancaiamao
tiancaiamao reviewed Sep 29, 2020
View reviewed changes
CONTRIBUTING.md Outdated

## Hacktoberfest

TiDB is in Hacktoberfest 2020! [Hacktoberfest](https://hacktoberfest.digitalocean.com/) is a month-long celebration & challenge of open source projects organized by DigitalOcean, Intel, and DEV. Whether you are a seasoned contributor or looking for projects to contribute to for the first time, you’re welcome to participate. Open four or more high-quality pull requests between **October 1 and 31** to any public repositories to get a limited edition Hacktoberfest T-shirt!
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
TiDB is in Hacktoberfest 2020! [Hacktoberfest](https://hacktoberfest.digitalocean.com/) is a month-long celebration & challenge of open source projects organized by DigitalOcean, Intel, and DEV. Whether you are a seasoned contributor or looking for projects to contribute to for the first time, you’re welcome to participate. Open four or more high-quality pull requests between **October 1 and 31** to any public repositories to get a limited edition Hacktoberfest T-shirt!
TiDB is in Hacktoberfest 2020! [Hacktoberfest](https://hacktoberfest.digitalocean.com/) is a month-long celebration & challenge of open source projects organized by DigitalOcean, Intel, and DEV. Whether you are a seasoned contributor or looking for projects to contribute to for the first time, you're welcome to participate. Open four or more high-quality pull requests between **October 1 and 31** to any public repositories to get a limited edition Hacktoberfest T-shirt!

@sre-bot
Copy link
Contributor

sre-bot commented Sep 29, 2020

No release note, Please follow https://github.com/pingcap/community/blob/master/contributors/release-note-checker.md

@dcalvin
Copy link
Contributor Author

dcalvin commented Sep 29, 2020 •
edited
Loading

As discussed - now we still use the old placement of contributing guide (in the community repo), with some optimization in the content and structure. See pingcap/community#308 @pingcap/tidb-maintainer

zz-jason
zz-jason approved these changes Sep 29, 2020
View reviewed changes
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-srebot ti-srebot removed the status/LGT1 Indicates that a PR has LGTM 1. label Sep 29, 2020
@ti-srebot ti-srebot added the status/LGT2 Indicates that a PR has LGTM 2. label Sep 29, 2020
@jackysp
Copy link
Member

jackysp commented Sep 29, 2020

/merge

@ti-srebot ti-srebot added the status/can-merge Indicates a PR has been approved by a committer. label Sep 29, 2020
@ti-srebot
Copy link
Contributor

/run-all-tests

@ti-srebot ti-srebot merged commit 21549e4 into pingcap:master Sep 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tiancaiamao tiancaiamao tiancaiamao left review comments

@AndreMouche AndreMouche AndreMouche left review comments

@ti-srebot ti-srebot ti-srebot approved these changes

@zz-jason zz-jason zz-jason approved these changes

@winkyao winkyao winkyao left review comments

Assignees
No one assigned
Labels
status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
8 participants
@dcalvin @sre-bot @winkyao @AndreMouche @jackysp @ti-srebot @tiancaiamao @zz-jason