Guide de contribution

Comment influencer le développement ? C'est très simple, pas besoin de grandes connaissances !

Comment contribuer ?

Tu veux influencer le développement ? C’est très simple ! Tu trouveras une liste de choses à faire sur Trello.

🙃 Aucune connaissance ?

Pas de problème ! Tu peux aider simplement en proposant des améliorations ou en rapportant des bugs par mail (app@amicale-insat.fr), sur Discord, ou sur cette page en te connectant avec tes login INSA.

🌍 Bilingue ou plus ?

Tu peux aider à traduire l’application ! Le projet existe en français et anglais (mais il peut y avoir des fautes !), et toute autre langue est la bienvenue.

Si tu es intéressé, rends-toi sur cette page pour plus de détails.

🤓 Développeur dans l’âme ?

Peu importe ton niveau, toutes les propositions de modification sont les bienvenues ! (enfin presque)

Pour cela, suis ce guide.

🤯 Motivé mais perdu ?

Tu es quand même le bienvenu ! Tu trouveras une liste de liens pour t’aider à comprendre les technologies utilisées dans ce projet. Si tu as plus de questions, tu peux toujours me contacter par mail (app@amicale-insat.fr).

Contribuer du code

Tu veux contribuer au projet ? Mais c’est magnifique ! Ce guide va te montrer comment faire pour contribuer tes modifications.

Si tu as des problèmes ou des questions, n’hésite pas à me contacter par mail (app@amicale-insat.fr).

⚠️ Avant de commencer, merci de te familiariser avec les bases !

Prérequis

Avant toute chose, tu dois installer React Native et git sur ta machine. Pour cela, suis ce guide jusqu’à l’étape 3.

Quoi faire ?

Tu trouveras une liste de choses à faire sur Trello.

Fork du projet

Si tu as bien suivi les instructions plus haut, tu devrais pouvoir lancer une application vide sur un appareil. Si ce n’est pas le cas, recommence l’installation depuis le début. Si malgré tout tu n’y arrives pas, envoie-moi un petit mail : app@amicale-insat.fr.

Il est maintenant temps de Fork le projet. Le dépôt officiel est protégé pour éviter le vandalisme. Un fork permet de copier le code du dépôt officiel et de le lier à ton compte. Sur cette nouvelle version, tu pourras faire les modifications que tu veux, et ensuite demander de fusionner ces modifications avec le dépôt officiel. Le mainteneur actuel du projet vérifiera alors tes modifications et décidera ou non de les accepter.

Plus d’infos sur git ici.

Créer un fork est très simple. Pour cela, suis ces instructions :

Création d’une nouvelle branche

Comme indiqué sur ce guide, chaque fonctionnalité doit être développée dans sa propre branche puis fusionnée avec le master du dépôt officiel.

Pour créer une nouvelle branche, utilise la commande suivante :

git checkout -b <branch-name>

En remplaçant <branch-name> par le nom souhaité (sans espaces !). Ce nom doit décrire rapidement ce que tu veux faire grâce à tes modifications.

Tu es maintenant sur ta nouvelle branche et prêt à faire tes modifications.

Réalisation d’une modification

Tu peux maintenant modifier ce que tu veux pour corriger un bug ou ajoute une fonctionnalité.

Mais avant de faire quoi que ce sois, merci de te signaler ! Cela évitera que plusieurs personnes corrigent le même bug ou de commencer à développer une fonctionnalité non voulue.

Pour installer l’appli sur ton téléphone/émulateur, reviens sur le guide d’installation, et reprends à la section 3.2.

Avant de passer à l’étape suivante, merci de bien vérifier et tester tes modifications.

Création d’une Pull Request

Cette étape te permet d’envoyer tes modifications sur le dépôt officiel, pour être intégrées à l’application disponible dans les magasins.

Tout se fait simplement sur le site en suivant ces instructions :

Et voilà tu as fait ta première pull request !

Si tu as des problèmes ou des questions, n’hésite pas à me contacter par mail (app@amicale-insat.fr).

Contribuer des traductions

Tu peux traduire l’application sans avoir de connaissance en programmation.

Pour cela, suis cette procédure :

Envoie-moi un mail avant de commencer pour me prévenir que tu veux travailler sur une traduction. Cela me permettra de te mettre en relation avec d’autres personnes travaillant également sur cette traduction.

Tu peux traduire dans la langue que tu veux, sachant que le français et l’anglais sont déjà fait.

Organisation du travail

⚠️ Ce projet dépend entièrement sur Git. Si tu n’es pas familier à cette technologie, rends-toi sur cette page avant de lire la suite.

La méthode ci-dessous est très fortement recommandée, car son efficacité a été testée et prouvée par de nombreux projets Open Source.

Ce qui suit a été inspiré des règles de KDE et largement simplifié.

Principes de base

La branche Master est toujours prête

Cette branche est le centre du projet. Elle ne doit contenir que des fonctionnalités et améliorations achevées. Elle doit être prête pour une release à tout moment. Le code doit donc être testé et validé.

Le développement à lieu dans les branches de ‘fonctionnalités’

Pour des corrections de bugs ou l’implémentation de nouvelles fonctionnalités qui demandent du travail, il est nécessaire de créer une nouvelle branche depuis master. Le développeur peut manipuler cette branche comme il le souhaite, mais elle doit être testée et vérifiée avant d’être fusionnée avec master.

Mainteneurs vs contributeur externe

Les contributeurs externes sont des volontaires qui veulent aider ponctuellement pour corriger des bugs/ajouter des fonctionnalités. Ils doivent suivre la procédure pour créer un fork du projet et faire une pull request pour intégrer leurs changements.

Les mainteneurs sont les personnes de confiance ayant un accès en écriture sur le dépôt officiel. C’est eux qui vérifient et acceptent les pull requests. Ils peuvent push et merge directement sur le dépôt officiel pour simplifier le développement.

Tu veux devenir contributeur ? Fais un tour par ici pour comprendre comment faire.
Tu es motivé et tu veux devenir mainteneur ? Contacte-moi par mail app@amicale-insat.fr.