-
Notifications
You must be signed in to change notification settings - Fork 5.9k
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: Add AUHTORS.md into TiDB #3311
Conversation
I think we should keep different role of authors. How about add three sections ? Maintainer Committer and contributor. |
@ngaut Then we need to update the list manually, IMO. |
You are right, we can keep committers and maintainers in another file. |
OK, I will file a new commit soon. |
hanfei1991, hanfei, Fei Han, Han Fei, hanfei19910905 is the same boy. |
The result is a little different from github, it seems that GitHub doesn't treat merge commit as a commit. |
We need to use email as ID, not name + email, I will update the doc soon, again. |
864465c
to
f2ea789
Compare
https://github.com/gaocegege/tidb/blob/721520db8208d0a2d2f6e9fbf0836f2b26e77846/AUTHORS.md Abandon the git way, use GitHub API to get all contributors. |
AUTHORS.md
Outdated
@@ -0,0 +1,231 @@ | |||
# Authors | |||
|
|||
This list is sorted by the number of commits per contributor in descending order. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/This list is sorted by the number of commits per contributor in descending order/The list is auto-generated by xxx scripts, please do not edit. The list is sorted by the number of commits per contributor in descending order/
AUTHORS.md
Outdated
|
||
[@hawkingrei](https://github.com/hawkingrei) | ||
|
||
###### Auto generated by [gaocegege/maintainer](https://github.com/gaocegege/maintainer) on 2017-05-22 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please remove the two lines.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is auto-generated, if remove, remember to remove the text every time we update the doc.
PTAL |
PTAL @queenypingcap |
LGTM |
@shenli @ngaut Any particular reason for the extension |
I think markdown has better human readability. |
@gaocegege I am agree with you. |
I did not say markdown is bad. Github can still render md file even without
the extension. I was suggesting replace Authors.md with Authors.
…On Thu, May 25, 2017 at 9:46 AM, Shen Li ***@***.***> wrote:
@gaocegege <https://github.com/gaocegege> I am agree with you.
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#3311 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AMtCBEM3Zeyn4jEE7CkVpJbHtyaWvzXhks5r9N1sgaJpZM4Nh54j>
.
|
I know, but markdown supports URL link, which we could use to redirect to the contributors' GitHub profile page. And IMO, people use plain text, not markdown because AUTHORS is an old thing, there is no markdown at that time, so open source developers follows the convention today. And you know README is in plain text before markdown get popular, too, now we are all use markdown, not plain text to write it. If we use plain text, instead, then we couldn't click the contributors' name or email to trigger a GitHub redirect like this or a mailto: link. WDYT 🤔 |
Wow. That is cool. I did not know that. lol. point taken.
…On Thu, May 25, 2017 at 10:14 AM, Ce Gao ***@***.***> wrote:
I know, but markdown supports URL link, which we could use to
contributors' GitHub profile page.
And IMO, people use plain text, not markdown because AUTHORS is an old
thing, there is no markdown at that time, so open source developers still
use plain text today. And you know README is in plain text before markdown
get popular, too, now we are all use markdown, not plain text to write it.
If we use plain text, instead, then we couldn't click the contributors'
name or email to trigger a GitHub redirect or a mailto: link.
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#3311 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AMtCBLI6mq2wxhDQ5LKbmfpBKUKrIn7Nks5r9OQegaJpZM4Nh54j>
.
|
Signed-off-by: Ce Gao <[email protected]>
I have added all contributors in one This will be the final version, IMO. |
There are some new repos which uses markdown to write AUTHORS now 😄 We are "第一个吃螃蟹的人" |
LGTM |
Motivation
GitHub only shows 100 contributors in pingcap/tidb/graphs/contributors, but every contributor is unique in the community, so I think it is time to import AUTHORS into TiDB.
Generation
Order
Now the file is generated by
git log --format='%aN <%aE>'
. Is it necessary to reorder the output alphabetically?