Skip to content

Commit

Permalink
add more explanations in README (#1)
Browse files Browse the repository at this point in the history
* Update README.md

* fix some writing issues

* Update license
  • Loading branch information
abdounasser202 committed Mar 23, 2021
1 parent 68145a1 commit 72a9f43
Showing 1 changed file with 86 additions and 2 deletions.
88 changes: 86 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,86 @@
# yotas
Oss's monetisation system
# Yotas

Oss's reward system

[French](#french)

[English](#english)

# english

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.

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

## Description
The yota will be an award 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 awards 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.
- A resource could be some money or anything else.

**Note that 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 award 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

Yotas est un système de récompense de l'engagement dans les projets open source. Les contributeurs open source de l'organisation sont récompensés pour les efforts et l'énergie qu'ils consacrent à la plateforme. Chaque interaction qu'ils ont sur GitHub leur donne un certain nombre de Yotas qui peuvent être échangés contre des goodies, du mentoring, des ebooks (etc...) dans une boutique OSS.

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

## Description
Le yota sera une récompense liée à l'organisation, que l'utilisateur obtiendra en soumettant des issues, en faisant du code review, pull requests, etc. Ils pourront utiliser ces yotas bien gagnés pour acheter des choses dans notre boutique comme un tête à téte avec le lead du projet, des t-shirts, une connexion internet (nécessite de l'argent réel), du temps dans un espace de coworking (nécessite un partenariat) et bien plus encore.

## Fonctionnement

Yotas est un système qui permet aux organisations open source de décerner des prix à leurs contributeurs en fonction des ressources dont ils disposent.

Voici le schéma :

- Je suis une organisation X avec Y ressources
- Je veux redistribuer Y aux contributeurs actifs.
- Chaque fois qu'une personne contribue, elle gagne des yotas, et avec nos Y ressources nous mettons en place une boutique où le contributeur achète en yotas.
- Une ressource peut être de l'argent ou n'importe quoi d'autre.

**Notez que le but des yotas n'est pas de convertir la contribution en argent**.

Ce n'est pas non plus un moyen de financer un projet open source, mais il peut permettre d'utiliser les fonds reçus pour récompenser les contributeurs.

Les sponsors Github et les Yotas peuvent être utilisés ensemble comme suit :

- L'organisation X reçoit un financement et dispose donc de Y ressources
- Avec ces ressources, elle crée une boutique où elle place des articles que ses contributeurs peuvent acheter sur Yotas.

Ce qui peut être mis dans une boutique 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, la première étape est d'offrir un mentorat aux juniors, et nous essayons d'avoir des issues abordables pour qu'ils puissent contribuer. Mais nous réfléchissons encore à ce que nous pouvons offrir d'autre, en particulier aux seniors.

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

## License

[GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0)

0 comments on commit 72a9f43

Please sign in to comment.