Bienvenue chez Plinkk Corp — l’organisation centrale pour tous les projets, plateformes et extensions autour de Plinkk.
- À propos
- Projets & architecture
- Conventions & bonnes pratiques
- Flux de travail (workflow)
- Contributions
- Communication & support
- Licence
Plinkk Corp est l’organisation qui héberge les projets liés à la technologie Plinkk.
Chaque dépôt représente une partie du système complet : frontend, backend, extensions, outils, etc.
L’objectif est de favoriser la cohérence, la modularité, et le développement collaboratif.
Voici les principaux dépôts de l’organisation :
| Nom du dépôt | Description synthétique | Langage / technologie principale |
|---|---|---|
plinkk |
Le cœur — template site de liens & interface client | TypeScript (frontend) |
plinkk-backend |
API / serveur & logique métier | JavaScript / Node.js |
.github |
Configuration globale (workflows, templates, etc.) | YAML / GitHub Actions |
⚠️ Cette table peut évoluer : ajoute les nouveaux dépôts dès qu’ils sont créés (ex : modules, plugins, outils internes…).
- Chaque dépôt doit avoir ses propres README, tests, documentation.
- Eviter le code dupliqué entre dépôts : mutualiser les composants ou librairies si possible.
- Utiliser des conventions communes (noms de branches, noms de commits, style de code) pour uniformité.
Voici quelques règles clés pour collaborer efficacement :
-
Nom des branches :
- feature/nom-fonctionnalité
- fix/description-bug
- chore/nom-tâche
-
Commits : messages clairs, impératifs. Exemple :
Ajoute la validation des emails -
Pull Requests (PRs) :
- Demander au moins une revue (peer review).
- Lier à une issue si nécessaire.
Voici un exemple de workflow que l’équipe peut adopter :
- Créer une issue décrivant le besoin ou le bug.
- Créer une branche spécifique issue/feature/fix depuis
main. - Développer sur cette branche, avec des commits propres.
- Pousser la branche, ouvrir une Pull Request vers la branche principale.
- Faire les revues, corriger les retours, fusionner après approbation.
- Après fusion, déclencher les pipelines CI/CD pour tests / déploiement.
Selon les besoins, on peut ajouter une branche develop, ou adopter GitFlow.
Tu souhaites contribuer à Plinkk ? Voici comment :
- Forker le dépôt dans ton compte GitHub.
- Créer une branche locale pour ta contribution.
- Appliquer les conventions ci-dessus (commits, tests, etc.).
- Soumettre une Pull Request.
- Un membre de l’équipe fera la revue et discutera avec toi des éventuelles corrections.
Merci de suivre le code de conduite.
- Canal Discord pour les développeurs
- Issues GitHub pour le suivi des bugs / améliorations
- Documentation centralisée (wiki / dossier
docs/dans les dépôts)
Tous les projets de Plinkk Corp sont sous licence MIT.
Voir fichier LICENSE.md à la racine de chaque dépôt.