add more explanations in README #1
Conversation
README.md
Outdated
|
|
||
| # english | ||
|
|
||
| Yotas is OSS's reward system, we would like our open source contributors across the organisation to be rewarded for the effort and energy they put into the platform. Each interaction they have on GitHub will give them a certain number of yotas which they can exchange for goodies in an OSS shop, mentoring, ebooks, etc.... |
There was a problem hiding this comment.
This is awesome, please some minor corrections
Yotas is an open source engagement awarding system. Open source contributors across the organisation are awarded for the effort and energy they put into the platform. Each interaction they have on GitHub will give them a certain number of Yotas which can be traded for goodies, mentoring, ebooks (etc...) in an OSS shop.
| Yotas is OSS's reward system, we would like our open source contributors across the organisation to be rewarded for the effort and energy they put into the platform. Each interaction they have on GitHub will give them a certain number of yotas which they can exchange for goodies in an OSS shop, mentoring, ebooks, etc.... | ||
|
|
||
| ## Why? | ||
| Contributing to open source takes some effort, and we would like every contributor to be rewarded for the time and energy they put into helping our community. |
There was a problem hiding this comment.
We should change all rewards to awards - the Admins determine (award) what is given to the contributor for the job done
README.md
Outdated
| Contributing to open source takes some effort, and we would like every contributor to be rewarded for the time and energy they put into helping our community. | ||
|
|
||
| ## Description | ||
| This reward system is strongly inspired by the correction points and wallet points system applied at Ecole 42. Correction points at Ecole 42 are points that students earn by correcting other students' projects, and lose when they have other students correct their projects. Wallet points are earned when a user contributes to the community, and wallets are directly redeemable for gifts such as 42 logo t-shirts, jacuzzi and other fun rewards. |
There was a problem hiding this comment.
We can eliminate this from the description; it will difficult to reference Ecole 42 for a description of their own reward system; unless we can have an article pointing to it as a reference
| This is a web project, which will be heavily based on a GitHub application that will monitor all events in the organisation and award interaction points. | ||
|
|
||
|
|
||
| # french |
There was a problem hiding this comment.
Please if you can reflect suggested corrections from the English to the French translations, it will be awesome!!
👍 For taking time to write all this out, you are awesome!
There was a problem hiding this comment.
done
it's only based on our yesterday's discussion
i havent invent anything
There was a problem hiding this comment.
Amazing work, I am happy to keep the README with that much descriptive text for now. But I think the README should have less informations regarding what the project is but more about how to run and use it. We should be following something similar to what is described on this checklist https://github.com/ddbeck/readme-checklist/blob/main/checklist.md
It will take a while before we have a website with an apropos or a proper README. So I am happy to merge this if you are @abdounasser202
README.md
Outdated
|
|
||
| ## License | ||
|
|
||
| [MIT](https://choosealicense.com/licenses/mit/) |
There was a problem hiding this comment.
Can we move to license to this to GPL3 pointing to https://choosealicense.com/licenses/gpl-3.0 ?
There was a problem hiding this comment.
@elhmn This project is in their early stage and i suggest to put all necessary information in the README so that everyone could understand the idea
Then in the future, we can readapt the README as expected
According to our recent discussion on Telegram, and some questions, i think the project should be more explained to avoid missunderstands