Skip to content
This repository has been archived by the owner on Jul 29, 2023. It is now read-only.

Commit

Permalink
Merge pull request #43 from shubhsherl/Sing-Li-patch-1
Browse files Browse the repository at this point in the history
Humble down the title and better doc default sort
  • Loading branch information
shubhsherl committed Mar 17, 2019
2 parents 1ff4cfd + 55d0bad commit c9eb3ce
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@

# Rocket.Chat GSoC Contributions Leaderboard
# GSoC Contributions Leaderboard

![Rocket.Chat GSoC Contributions Leaderboard screenshot](images/contribution-leaderboard.png)

A contributions leaderboard for your GSoC organization. Students can track their position on leaderboard based on the PRs, commits, and issues they've completed across the repositories of your organization on Github.
A contributions leaderboard for your GSoC organization. Students can track their position on leaderboard based on the PRs, commits, and issues they've completed across the repositories of your organization on Github. Proudly created and maintined by the GSoC 2019 students and the [Rocket.chat community](https://github.com/RocketChat/Rocket.Chat).

## Benefits
- Encourage students to improve their position - by increasing contribution to your organization
Expand Down Expand Up @@ -41,6 +41,7 @@ ORGANIZATION_LOGO=''
ORGANIZATION_SITE=''
GITHUB_AUTH_TOKEN=''
DEFAULT_SORT=''
SHOW_RANK=''
```

Apply database migrations
Expand Down Expand Up @@ -68,8 +69,22 @@ python manage.py createsuperuser
Start the refresh script

### Default Sort
`DEFAULT_SORT` used for ranking takes numberic value from 1-7. Assigned numbers for Open Pulls, Merged Pulls, Issues are 1,2,4 respectively.
For example: To include Open and Merged Pulls set `DEFAULT_SORT=3`. To include Merged Pulls and Issues set `DEFAULT_SORT=6`.

The default sort weight only open and merged pulls, for [Rocket.Chat](https://gsoc.rocket.chat) we found this worked best for our student community. You can flexibly change this multi-fields sort order by modifying the `.env` file.

Environment variable to change for default sort order:

`DEFAULT_SORT`

This variable is used for ranking. It is encoded as:

Value | Metrics
--------------------------------|----------------------------------------------------------------
1 | Open Pulls
2 | Merged Pulls
4 | Issues

Add the values to combine the metrics. For example: To include Open and Merged Pulls set `DEFAULT_SORT=3`. To include Merged Pulls and Issues set `DEFAULT_SORT=6`


### Architecture
Expand Down

0 comments on commit c9eb3ce

Please sign in to comment.