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: Add AUHTORS.md into TiDB #3311

Merged
merged 2 commits into from
May 25, 2017
Merged

Conversation

gaocegege
Copy link
Contributor

@gaocegege gaocegege commented May 22, 2017

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

cd ${GOPATH}/src/github.com/pingcap/tidb
go get github.com/gaocegege/maintainer
maintainer contributor

Order

Now the file is generated by git log --format='%aN <%aE>'. Is it necessary to reorder the output alphabetically?

@gaocegege gaocegege changed the title Add authors into TiDB docs: Add AUHTORS.md into TiDB May 22, 2017
@ngaut
Copy link
Member

ngaut commented May 22, 2017

I think we should keep different role of authors. How about add three sections ? Maintainer Committer and contributor.

@gaocegege
Copy link
Contributor Author

@ngaut Then we need to update the list manually, IMO.

@ngaut
Copy link
Member

ngaut commented May 22, 2017

You are right, we can keep committers and maintainers in another file.
Also we should keep the authors order by commit count, let's keep consistent with github.

@gaocegege
Copy link
Contributor Author

OK, I will file a new commit soon.

@hanfei1991
Copy link
Member

hanfei1991, hanfei, Fei Han, Han Fei, hanfei19910905 is the same boy.

@gaocegege
Copy link
Contributor Author

The result is a little different from github, it seems that GitHub doesn't treat merge commit as a commit.

See https://pastebin.com/7AFCGrQq

@gaocegege
Copy link
Contributor Author

We need to use email as ID, not name + email, I will update the doc soon, again.

@gaocegege
Copy link
Contributor Author

gaocegege commented May 22, 2017

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.
Copy link
Member

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
Copy link
Member

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.

Copy link
Contributor Author

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.

@gaocegege
Copy link
Contributor Author

PTAL

@ngaut
Copy link
Member

ngaut commented May 23, 2017

PTAL @queenypingcap

@shenli
Copy link
Member

shenli commented May 24, 2017

LGTM

@zhexuany
Copy link
Contributor

zhexuany commented May 25, 2017

@shenli @ngaut Any particular reason for the extension .md? Many open source project does not have such extension. Instead, Authors will be enough. for example https://github.com/bazelbuild/bazel/blob/master/AUTHORS

@gaocegege
Copy link
Contributor Author

I think markdown has better human readability.

@shenli
Copy link
Member

shenli commented May 25, 2017

@gaocegege I am agree with you.

@zhexuany
Copy link
Contributor

zhexuany commented May 25, 2017 via email

@gaocegege
Copy link
Contributor Author

gaocegege commented May 25, 2017

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 🤔

@zhexuany
Copy link
Contributor

zhexuany commented May 25, 2017 via email

Signed-off-by: Ce Gao <ce.gao@outlook.com>
@gaocegege
Copy link
Contributor Author

I have added all contributors in one <ul> list, PTAL

This will be the final version, IMO.

@gaocegege
Copy link
Contributor Author

@zhexuany 🥂

There are some new repos which uses markdown to write AUTHORS now 😄 We are "第一个吃螃蟹的人"

@ngaut
Copy link
Member

ngaut commented May 25, 2017

LGTM

@tiancaiamao tiancaiamao added the status/LGT2 Indicates that a PR has LGTM 2. label May 25, 2017
@tiancaiamao tiancaiamao merged commit a630a9a into pingcap:master May 25, 2017
@gaocegege gaocegege deleted the docs/authors branch May 25, 2017 06:19
@sre-bot sre-bot added the contribution This PR is from a community contributor. label Dec 18, 2019
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution This PR is from a community contributor. status/LGT2 Indicates that a PR has LGTM 2.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants