From b8a6b3e86c2d9e4cac7ee0ea01148d809429c456 Mon Sep 17 00:00:00 2001 From: Hyko Date: Sun, 12 Apr 2026 15:13:11 -0400 Subject: [PATCH] docs: update org name from hykocx to zen and expand DEV guide - Replace `hykocx` with `zen`/`HYKO` in LICENSE copyright notices - Update npm registry scope from `@hykocx` to `@zen` in INSTALL.md - Update npm auth token config path to use `zen` org in DEV.md - Add project structure overview to DEV.md - Add contribution standards section referencing GUIDE.md and REDACTION.md - Add semver versioning bump reference table to DEV.md --- LICENSE | 6 +++--- docs/INSTALL.md | 2 +- docs/dev/DEV.md | 38 +++++++++++++++++++++++++++++++++++++- 3 files changed, 41 insertions(+), 5 deletions(-) diff --git a/LICENSE b/LICENSE index b9d5e92..229da06 100644 --- a/LICENSE +++ b/LICENSE @@ -208,8 +208,8 @@ If you develop a new program, and you want it to be of the greatest possible use To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found. - zen - Copyright (C) 2026 hykocx + ZEN + Copyright (C) 2026 HYKO This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. @@ -221,7 +221,7 @@ Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: - zen Copyright (C) 2026 hykocx + ZEN Copyright (C) 2026 HYKO This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 15c7bec..27379af 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -5,7 +5,7 @@ Créer un fichier `.npmrc` à la racine du projet avec le contenu suivant : ``` -@hykocx:registry=https://git.hyko.cx/api/packages/hykocx/npm/ +@zen:registry=https://git.hyko.cx/api/packages/zen/npm/ ``` ## 2. Installer le package diff --git a/docs/dev/DEV.md b/docs/dev/DEV.md index 120a5a3..11fafa1 100644 --- a/docs/dev/DEV.md +++ b/docs/dev/DEV.md @@ -1,5 +1,27 @@ # DEV +## Standards + +Toute contribution doit respecter les guides suivants : + +- [GUIDE.md](GUIDE.md) — conventions générales de rédaction et de structure +- [REDACTION.md](REDACTION.md) — règles de style, ton et formatage + +--- + +## Structure du projet + +``` +src/ +├── cli/ # Scripts CLI : zen-db, zen-setup +├── core/ # Briques techniques : database, api, email, storage, cron, pdf, toast, payments +├── features/ # Features utilisateur : auth, admin, provider +├── modules/ # Modules métier : posts, invoice, nuage… +└── shared/ # Composants, lib et styles partagés +``` + +--- + ## Publier le package Le package `@zen/core` est publié sur le registre npm à `https://git.hyko.cx`. @@ -9,7 +31,7 @@ Le package `@zen/core` est publié sur le registre npm à `https://git.hyko.cx`. Créer un token d'accès dans Gitea (Settings → Applications → Generate Token), puis l'enregistrer localement : ```bash -npm config set //git.hyko.cx/api/packages/hykocx/npm/:_authToken TOKEN +npm config set //git.hyko.cx/api/packages/zen/npm/:_authToken TOKEN ``` Remplacer `TOKEN` par le token généré. @@ -21,3 +43,17 @@ npm publish ``` Le script `prepublishOnly` lance automatiquement le build avant la publication. + +--- + +## Bump de version + +Modifier `"version"` dans `package.json` en suivant [semver](https://semver.org/) : + +| Changement | Version | +|------------|---------| +| `fix` — correctif | PATCH `1.x.X` | +| `feat` — nouvelle fonctionnalité | MINOR `1.X.0` | +| Breaking change | MAJOR `X.0.0` | + +--- \ No newline at end of file