Merci de vouloir améliorer lomi. Corrections, nouvelles fonctionnalités, documentation ou signalements : chaque contribution compte.

Comment contribuer

Plusieurs façons d’aider :

Signaler des bugs : ouvrez une issue sur GitHub Issues.
Proposer des évolutions : partagez vos idées via GitHub Issues.
Coder : contribuez directement au dépôt. Voir les Bonnes pratiques.
Documentation : rendez-la plus claire et plus complète.
Communauté : aidez les autres sur le Discord.

Liens utiles

Avant de commencer :

Code de conduite : ce que nous attendons dans la communauté.
Bonnes pratiques : étapes concrètes pour le code et la doc.
Stratégie de branches : gestion des branches et des releases.

Merci encore pour votre intérêt !

Premiers pas

Prêt pour une première contribution ? Ce guide couvre choix d’une issue, environnement local, modifications et publication.

Prérequis

Installez notamment :

Git pour le contrôle de version.
Node.js — dernière LTS recommandée.
bun — gestionnaire préféré du monorepo.

Choisir une issue

Avant de coder, trouvez ou proposez une issue :

Parcourez les issues ouvertes.
Cherchez good first issue si vous débutez.
Pour une idée nouvelle ou un correctif, créez une issue pour en discuter.
Posez des questions dans les commentaires si besoin.

Fork du dépôt

Forkez le dépôt principal lomi. sur GitHub :

Ouvrez le dépôt lomi..
Mettez une étoile au projet !
Cliquez sur « Fork » en haut à droite.

Cloner votre fork

git clone https://github.com/beloved_anon/lomi.git
cd lomi.

Remplacez beloved_anon par votre identifiant GitHub réel.

Ajouter le remote upstream

Ajoutez le dépôt d’origine en upstream pour rester synchronisé.

git remote add upstream https://github.com/lomiafrica/lomi./

Vérification :

git remote -v
# origin  https://github.com/<YOUR_USERNAME>/lomi./ (fetch)
# origin  https://github.com/<YOUR_USERNAME>/lomi./ (push)
# upstream https://github.com/lomiafrica/lomi./ (fetch)
# upstream https://github.com/lomiafrica/lomi./ (push)

Dépendances et environnement

À la racine du monorepo :

bun install

Variables locales :

cp .env.example .env
# Complétez les secrets nécessaires

Commandes de développement locales

# Serveur de dev (voir le package.json de l’app concernée)
bun run dev

# Documentation en local
bun run docs:dev

# Lint projet
bun run lint

# Lint avec correction automatique
bun run lint:fix

Créer une branche

À partir de develop, en suivant la Stratégie de branches :

git fetch upstream
git checkout develop
git pull upstream develop

git checkout -b <BRANCH_TYPE>/<SHORT_DESCRIPTION>
# Exemple : git checkout -b feature/add-cool-new-thing
# Exemple : git checkout -b fix/resolve-that-bug

Réaliser les changements

Travaillez dans le bon dossier sous packages/ ou apps/.

Code : respectez nos Standards de code et Bonnes pratiques.
Documentation : mettez à jour apps/developers/src/pages/docs/ ou l’emplacement doc prévu au format Markdown (.mdx).

Maintenez la branche à jour avec upstream/develop :

# Fetch the latest changes from upstream
git fetch upstream

# Rebase your branch onto the latest develop branch
# Make sure you have committed or stashed your local changes first!
git rebase upstream/develop

# You might need to resolve conflicts during the rebase process.
# After resolving conflicts: git add . ; git rebase --continue
# If you get stuck: git rebase --abort

Tester vos changements

Assurez-vous que les tests pertinents passent et que la qualité est au rendez-vous.

# Example: Running tests for a specific package
# Replace <package_name> with the actual package, e.g., @lomi/api
bun --filter <package_name> test

# Run specific tests using a pattern (e.g., tests related to 'payment')
bun test -- --grep "payment"

# Run all tests across the monorepo
bun test

# Run tests and generate a coverage report
bun run test:coverage

Ajoutez des tests pour vos changements. Voir Standards de code.

Commiter

Messages conformes aux Conventions de commit pour automatiser releases et changelogs.

Format :

<type>(<scope>): <description>

# Examples:
# feat(api): add support for webhook signature verification
# fix(docs): correct typo in getting started guide
# chore(deps): update dependency xyz

Exemple :

git add .
git commit -m "feat(payments): implement new payment provider"

Voir Bonnes pratiques pour des exemples pertinents.

Pousser la branche

git push origin <BRANCH_NAME>

Ouvrir une pull request (PR)

Sur votre fork (https://github.com/<YOUR_USERNAME>/lomi.).
Proposition de PR sur la branche poussée : « Compare & pull request ».
Base : dépôt lomiafrica/lomi., branche develop.
Head : votre fork, branche fonctionnalité ou correctif.
Titre de PR clair : même style que les commits (<type>(<scope>): <description>).
Modèle de PR : décrivez clairement :
- Changements : quoi et pourquoi ?
- Le code respecte les conventions du projet.
- J’ai relu mon propre code.
- J’ai commenté les parties délicates.
- La documentation est à jour.
- Pas de nouveaux avertissements inutiles.
- Tests ajoutés pour la correction ou la fonctionnalité.
- bun test passe en local.
- Dépendances aval fusionnées si besoin.
- Commits fusionnés / messages explicites si nécessaire.
Soumettez la PR.

Processus de revue

Les mainteneurs examineront votre PR.

Pendant la revue

Réactivité : répondez aux commentaires rapidement.
Itérations : poussez des commits supplémentaires ; évitez le force-push sauf demande.
À jour : si develop avance, rebasez pour résoudre les conflits.

Après fusion

Félicitations ! Merci pour la contribution.
Nettoyage : supprimez la branche de fonctionnalité sur votre fork si vous le souhaitez.
Suivi : surveillez les issues liées ou le déploiement si applicable.

Étapes suivantes

La revue suit notre processus de code review ; des itérations peuvent être nécessaires. Nous répondrons rapidement.

Merci beaucoup.

Contribuer