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.

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

add more explanations in README #1

Merged
merged 3 commits into from
Mar 23, 2021
Merged
Changes from 1 commit
Commits
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
90 changes: 88 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,88 @@
# yotas
Oss's monetisation system
# Yotas

Oss's reward system

[French](#french)

[English](#english)

# 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....

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


## 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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should change all rewards to awards - the Admins determine (award) what is given to the contributor for the job done

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


## 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.
Copy link

@sherlockwisdom sherlockwisdom Mar 22, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


The yota will be a reward related to the organisation, which the user will get by creating problems, reviewing code, merging their pull requests, etc. They will be able to use these well earned yotas to buy things in our shop like a call with the project maintainer, t-shirts, internet connection (requires real money), time in a coworking space (requires partnership) and many more.

## How it works

Yotas is a system that allows open source organisations to give rewards to their contributors according to the resources they have.

Here is the schema:

- I am an organisation X with Y resources
- I want to redistribute Y to active contributors.
- Each time a person contributes, he earns yotas, and with our Y resources we set up a shop where the contributor buys in yotas.

**The purpose of yotas is not to convert the contribution into money.**

It is not a way to fund an open source project as well, but it can allow to use the funding received to reward the contributors.

Github sponsors and Yotas can be used together as follows:

- Organisation X receives funding and therefore has Y resources
- With these resource it creates a shop where it puts items that its contributors can buy in Yotas

What can be put in a shop on yotas can be anything and everything (mentoring, tutorials, goodies,...) it is up to the organisation to decide according to what it has.

For OSS, the first step is to offer mentoring to juniors, and we try to have affordable issues so that they can contribute. But we are still thinking about what else we can offer, especially to seniors.

## Note
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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

it's only based on our yesterday's discussion
i havent invent anything


Yotas est le système de récompense d'OSS, nous aimerions que nos contributeurs open source à travers l'organisation soient récompensés pour les efforts et l'énergie qu'ils mettent dans la plateforme. Chaque interaction qu'ils auront sur GitHub leur donnera un certain nombre de yotas qu'ils pourront échanger contre des goodies dans une boutique OSS, du mentorat, des ebooks, etc....

## Pourquoi ?
Contribuer à l'open source demande quelques efforts, et nous aimerions que chaque contributeur soit récompensé pour le temps et l'énergie qu'il met à aider notre communauté.

## Description
Ce système de récompense est fortement inspiré du système de points de correction et de points portefeuille appliqué à l'Ecole 42. Les points de correction à l'école 42 sont des points que les étudiants gagnent en corrigeant les projets d'autres étudiants, et perdent lorsqu'ils font corriger leurs projets par d'autres étudiants. Les points portefeuille sont gagnés lorsqu'un utilisateur contribue à la communauté, les portefeuilles sont directement échangeables contre des cadeaux comme des t-shirts avec le logo de 42, du temps dans le jacuzzi et d'autres récompenses amusantes.

Le yota sera une récompense liée à l'organisation, que l'utilisateur obtiendra en créant des problèmes, en révisant du code, en faisant fusionner ses pull request, etc. Ils pourront utiliser ces yotas bien gagnés pour acheter dans notre boutique des choses comme un appel avec le mainteneur du projet, des t-shirts, une connexion internet, du temps dans un espace de coworking et bien d'autres choses encore.

## Fonctionnement

Yotas est un systeme qui permet aux organisations open source de donner des récompenses à leurs contributeurs en fonction des moyens qu'elles disposent.

Voici le schemas:

- Je suis une organisation X qui dispose de Y moyens
- je souhaite redistribuer Y aux contributeurs actifs.
- Chaque fois qu'une personne contribue il gagne des yotas, et avec nos moyens Y on met en place un shop où le contributeur achète en yotas.

L'objectif de yotas n'est pas de convertir la contribution en argent.

Ce n'est pas un moyen pour financer un projet open source également, mais il peut permettre d'utiliser le financement reçu pour récompenser les contributeurs.

Github sponsors et Yotas peuvent etre utilisés ensemble comme suit:

- L'organisation X reçoit du financement donc possèdes Y ressources
- Avec ces ressources elle crée un Shop où elle mets des articles que ses contributeurs peuvent acheter en Yotas

Ce qui peut être mis dans un shop sur yotas peut être tout et n'importe quoi (mentoring, tutoriels, goodies,...) c'est à l'organisation de décider en fonction de ce qu'elle a.

Pour OSS dans un premier temps c'est proposer du mentoring aux juniors, et on essaye d'avoir des Issues assez abordables pour qu'ils puissent contribuer. Mais on refléchis encore sur ce qu'on peut proposer d'autre, notemment aux seniors.

## Note
Il s'agit d'un projet web, qui sera fortement basé sur une application GitHub qui surveillera tous les événements de l'organisation et attribuera des points d'interaction et attribuera des points d'interaction.

## License

[MIT](https://choosealicense.com/licenses/mit/)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we move to license to this to GPL3 pointing to https://choosealicense.com/licenses/gpl-3.0 ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree 100% with you. 👍