Contribution

Conventions de code, de langue, de rédaction et de commit, procédure de publication du package et administration du registre privé.

Ces pages s'adressent à qui modifie @lrvo/core lui-même, ou un package @lrvo/module-*.

PageSujet
Conventions de codeStandards, arborescence des features, suffixes de runtime, documentation.
LangueCe qui s'écrit en anglais, ce qui s'écrit en français.
RédactionVoix de l'interface, voix de la documentation, formules à éviter.
CommitsFormat Conventional Commits, types, breaking changes.
PublicationChecklist, versionnage semver, npm publish.
Notes de versionGénération de CHANGELOG.md et changelog.json, pieds de commit, ce que lrvo-update en tire.
Registre VerdaccioAdministration du registre privé : utilisateurs, packages, tags, droits.

Règle qui prime sur les autres

On corrige la cause racine, jamais les symptômes. Si le même type d'erreur réapparaît dans un deuxième fichier après avoir corrigé le premier, c'est le signe que le vrai fix est ailleurs. Remonter la chaîne d'imports ou d'appels jusqu'à comprendre pourquoi ce code est atteint dans ce contexte, puis corriger à cet endroit.

Documentation

Toute la documentation vit dans docs/. Aucun fichier .md ne réside dans src/. Une modification de code n'est pas terminée tant que la page de docs/ concernée n'est pas à jour.

Propriété du code

LRVO est un produit propriétaire. Une contribution provenant d'une personne extérieure à ACARY exige une cession de droits signée avant la fusion : sans elle, son auteur reste titulaire du droit d'auteur sur son code. Ajouter une dépendance impose aussi de vérifier sa licence, aucune dépendance copyleft n'étant admise. Voir Licence et propriété.

Sur cette page