|
1 | 1 | # About Codebadge |
| 2 | + |
| 3 | +[](http://prabhani.me/Codebadge) |
| 4 | +[](https://travis-ci.com/PrabhaniN/Codebadge) |
| 5 | + |
| 6 | +[](https://github.com/PrabhaniN/Codebadge/blob/master/LICENSE) |
| 7 | + |
2 | 8 | Well we all have been working in Open Source and committing various Pull requests and issues. Many a times it may happen that a mentor is unanle to manage all these activities. So This project is about tracking the contributor as well as its contribution by respective mentors. |
3 | 9 |
|
4 | 10 | ### Features |
5 | 11 |
|
6 | | - - Easy to monitor the activities of various contributors. |
7 | | - - Visibility of top contributors in various projects. |
8 | | - - Real time tracking of commits, PR's and other contributions. |
9 | | - - Contributors list based on number of PR's, merged pulls and other activities. |
10 | | - - Contribution history of each contributor. |
| 12 | +- Easy to monitor the activities of various contributors. |
| 13 | +- Visibility of top contributors in various projects. |
| 14 | +- Real time tracking of commits, PR's and other contributions. |
| 15 | +- Contributors list based on number of PR's, merged pulls and other activities. |
| 16 | +- Contribution history of each contributor. |
11 | 17 |
|
12 | 18 | The other part of this project includes the “notifying moderator” since we see sometimes that there are many PRs being sent, or issues being opened by various people across the globe but there are limited numbers of maintainers merging the PRs. This way organisations usually lose their potential contributors due to following things: |
13 | 19 |
|
14 | | - - Their PRs are not being merged |
15 | | - - They finds difficulty in understanding the issue |
16 | | - - They could not reach to expectation |
17 | | -So this will help the maintainers get notified when they see these people inactive. |
| 20 | +- Their PRs are not being merged |
| 21 | +- They finds difficulty in understanding the issue |
| 22 | +- They could not reach to expectation |
| 23 | + So this will help the maintainers get notified when they see these people inactive. |
18 | 24 |
|
19 | 25 | ## How does it work |
| 26 | + |
20 | 27 | For instance, suppose a contributor “X” has been quite active within the community by working on various PRs, opening and resolving various issues, active on chat channels but after a month “X” gets disappeared. So by using this dashboard they will have a badge interface. There will be a badge attached in front of the name of the contributor. Let the name of the badge be “Y” so this badge will have a unique color. So as the time passes like “ a day went, 1 week went, 2 weeks went, a month, etc) this badges will get keep on fading. And Every fade color will have a unique reason. For example, when a contributor made a PR, the badge appeared “Red” in color. This badge will remain in the same color as long as he/she is contributing. Assume that contributor stops contributing and has not contributed for a week so his badge will become green in color. And this will keep on notifying mainaters, Admins about their disappearing. This way the organisations will have greater eye on the contributors and can help them sustain with the community. |
21 | 28 |
|
22 | 29 | ## Stack used |
| 30 | + |
23 | 31 | This will have a dashboard, where these things can be placed. The stack used can be any but since the organisation have fixed stack so its better to stick to Nodejs, Vue, React. |
24 | 32 |
|
25 | 33 | ## Benefits to the community |
| 34 | + |
26 | 35 | Different communities or programs like “GirlScript Summer of Code, Codeheat, GSOC, etc would be able to track their contributors and this project will help them by not losing potential contributors and select the best from all potential candidates. |
27 | 36 |
|
28 | 37 | ## Contributions Best Practices |
| 38 | + |
29 | 39 | **Commits** |
30 | 40 |
|
31 | | - - Write clear meaningful git commit messages (Do read http://chris.beams.io/posts/git-commit/) |
32 | | - - Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (More info at https://github.com/blog/1506-closing-issues-via-pull-requests ) |
33 | | - - When you make very very minor changes to a PR of yours (like for example fixing a failing Travis build or some small style corrections or minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at https://davidwalsh.name/squash-commits-git ) |
34 | | - - When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker. |
| 41 | +- Write clear meaningful git commit messages (Do read http://chris.beams.io/posts/git-commit/) |
| 42 | +- Make sure your PR's description contains GitHub's special keyword references that automatically close the related issue when the PR is merged. (More info at https://github.com/blog/1506-closing-issues-via-pull-requests ) |
| 43 | +- When you make very very minor changes to a PR of yours (like for example fixing a failing Travis build or some small style corrections or minor changes requested by reviewers) make sure you squash your commits afterward so that you don't have an absurd number of commits for a very small fix. (Learn how to squash at https://davidwalsh.name/squash-commits-git ) |
| 44 | +- When you're submitting a PR for a UI-related issue, it would be really awesome if you add a screenshot of your change or a link to a deployment where it can be tested out along with your PR. It makes it very easy for the reviewers and you'll also get reviews quicker. |
35 | 45 |
|
36 | 46 | ## Community |
37 | | -All feedback and suggestions are welcome! |
38 | | - |
39 | | - - 💬 Join the community on [Slack](https://join.slack.com/t/codeuino/shared_invite/enQtMzcxOTQwNzE4NzcxLWEyNzUxYjI0ZThiNWUyYWI5MzJlMTNmODMxN2NjMTcxODJkZmFhNTVkYmUyOTQ1YzgzNTlmMTVkYzVhMzdmNTQ ) |
40 | | - - 📣 Stay up to date on new features and announcements on the following |
41 | | - - [@Mailing List ]([email protected]). |
42 | | - - [@Discussion Portal](https://groups.google.com/d/forum/codeuino-devel). |
43 | | - - [@Codeuino Wiki](wiki.codeuino.org). |
44 | 47 |
|
| 48 | +All feedback and suggestions are welcome! |
45 | 49 |
|
| 50 | +- 💬 Join the community on [Slack](https://join.slack.com/t/codeuino/shared_invite/enQtMzcxOTQwNzE4NzcxLWEyNzUxYjI0ZThiNWUyYWI5MzJlMTNmODMxN2NjMTcxODJkZmFhNTVkYmUyOTQ1YzgzNTlmMTVkYzVhMzdmNTQ) |
| 51 | +- 📣 Stay up to date on new features and announcements on the following |
| 52 | + - [@Mailing List ]([email protected]). |
| 53 | + - [@Discussion Portal](https://groups.google.com/d/forum/codeuino-devel). |
| 54 | + - [@Codeuino Wiki](wiki.codeuino.org). |
0 commit comments