From 09718ecd5c782614188931445c181e5881d68df2 Mon Sep 17 00:00:00 2001 From: SingLi Date: Sat, 16 Mar 2019 12:02:47 -0300 Subject: [PATCH 1/2] Humble down the title and better doc default sort --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d661fd5..d9de105 100644 --- a/README.md +++ b/README.md @@ -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 @@ -68,8 +68,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 +3 | 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 From 55d0badd9f28bf16e153e42b9a001aa68f9f0eae Mon Sep 17 00:00:00 2001 From: Shubham Singh Date: Sun, 17 Mar 2019 13:09:25 +0530 Subject: [PATCH 2/2] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d9de105..99ede47 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,7 @@ ORGANIZATION_LOGO='' ORGANIZATION_SITE='' GITHUB_AUTH_TOKEN='' DEFAULT_SORT='' +SHOW_RANK='' ``` Apply database migrations @@ -81,7 +82,7 @@ Value | Metrics --------------------------------|---------------------------------------------------------------- 1 | Open Pulls 2 | Merged Pulls -3 | Issues +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`