*: make contribution more newbie friendly#3102
Conversation
|
@zhexuany Nice work! |
|
@shenli More work will be done tonight. The goal of this commit is make contribution more newbie friendly. |
There was a problem hiding this comment.
TiDB is a community-driven open source project and welcomes any contributor.
There was a problem hiding this comment.
may be different from other projects that you've been involved in.
There was a problem hiding this comment.
Before pulling your first request to TiDB, you have to sign the CLA. It is noted that PingCAP only accepts the individual contributor license agreement, which means if your organization is the copyright holder, you can not contribute to this project.
There was a problem hiding this comment.
The first step is to fork TiDB to your own repository. After forking TiDB,
zhexuany
force-pushed
the
rewrite_contribution_guid
branch
3 times, most recently
from
9c516ef to
79f1d3f
Compare
|
@Wenting0905 PTAL |
There was a problem hiding this comment.
TiDB is a community-driven open source project and we welcome any contributor.
There was a problem hiding this comment.
different from many other projects that you've been involved in.
There was a problem hiding this comment.
find a requirement that this doc does not include or meet?
There was a problem hiding this comment.
using capture here is identical as using meet
There was a problem hiding this comment.
so why not use the more common one?
There was a problem hiding this comment.
It is a requirement for this doc. Sometime, contribution.md may be outdated. Under this circumstance, submitting a new issue about this doc is right practice.
There was a problem hiding this comment.
i find it hard to understand the 2nd point
There was a problem hiding this comment.
It is a Metaphor. pre flight check is needed whenever you take a plane. Submit a PR is like flight. Pre checking is necessary to ensure PR in a good quality.
There was a problem hiding this comment.
yeah, i know the pre-flight check but i didn't get the point of using a metaphor in a documentation. i hope contributors will understand such a metaphor.
There was a problem hiding this comment.
Actually, metaphor is used a lot quite in tech doc. I have read plenty of docs. Metaphor is the easiest way to convey knowledge to audience.
There was a problem hiding this comment.
Small PRs are easy to review while large ones are difficult.
There was a problem hiding this comment.
Separating for emphasizing.
There was a problem hiding this comment.
cannot understand what this sentence means.
There was a problem hiding this comment.
well. It is usually related with gofmt.
zhexuany
force-pushed
the
rewrite_contribution_guid
branch
from
8dd35be to
32cb6e5
Compare
|
@Wenting0905 PTAL |
|
@shenli @coocood PTAL. Most advice from @Wenting0905 is token. It should be ready to merge. But more advice are welcome. |
zhexuany
force-pushed
the
rewrite_contribution_guid
branch
2 times, most recently
from
c69d1c6 to
00df4b9
Compare
There was a problem hiding this comment.
Before you move on, please make sure what your issue and/or pull request is, a simple bug fix or an architecture change.
There was a problem hiding this comment.
Bug fixes is better.
There was a problem hiding this comment.
Performance improvement is always difficult to review, even for those experienced software engineers.
There was a problem hiding this comment.
- delete the redundant "that"
- support --> supports
There was a problem hiding this comment.
these --> this
"This" may be better if you want to refer to the event ("not to suggest a performance bug") instead of "examples"
zhexuany
force-pushed
the
rewrite_contribution_guid
branch
from
00df4b9 to
44aa6b8
Compare
|
LGTM |
|
@Wenting0905 @shenli PTAL. |
4 participants
It is just a proposal. More polish on the way.