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

Update README.md #54

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update README.md #54

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Hall-of-fame helps you show some love to your contributors. It automatically hig

## How it works

Every hour, Hall-of-fame looks into recent commits of your repo using GitHub API. It then selects three categories of contributors: new (those who made their first commit to your repo in the last 7 days), trending (those with most commits in the last 7 days), and top (those with most commits of all time). It then selects up to three new contributors, up to 4 trending contributors, and if total is less than 7, it fill up the remaining spots with top contributors.
Every hour, Hall-of-fame looks into recent commits of your repo using GitHub API. It then selects three categories of contributors: new (those who made their first commit to your repo in the last 7 days), trending (those with most commits in the last 7 days), and top (those with most commits of all time). It then selects up to three new contributors, up to 4 trending contributors, and if the total is less than 7, it fills up the remaining spots with top contributors.

Each contributor in the Hall-of-fame is represented with their avatar, and a badge new/trending/top with the corresponding number of commits. Each avatar links to a contributor's profile. Which means that anyone has a chance to be prominently featured on your README for some time!

Expand Down Expand Up @@ -77,7 +77,7 @@ Note that Hall-of-fame will use your GitHub token for hourly updates via GitHub

**A:** We want Hall-of-fame to change frequently (hence emphasis on changes in the last week), and we want it to be immediately exciting for your first time contributors. You need new contributors, right? We better make them excited.

**Q:** I just commited, and I don't see my face on Hall-of-fame! What is going on?
**Q:** I just committed, and I don't see my face on Hall-of-fame! What is going on?

**A:** It refreshes once an hour, and sometimes takes a bit longer. Just wait, it will be there. Another possibility is there are enough contributors with more commits this week. Contributors are sorted by the number of commits, so if you push another commit, you will increase your chance to show in Hall-of-fame.

Expand Down