Rédiger la doc de contribution #2

Open
opened 2026-01-19 13:22:15 +01:00 by f.piccinali · 11 comments
Member

Harmoniser le README principal et docs/developpement

Harmoniser le README principal et docs/developpement

Peut-on aussi commencer à écrire et discuter du worklow git :
à minima:

  • quand créer un pull request
  • que doit contenir le pull request pour être acceptable (nouveaux tests, tests OK, doc)
  • accord pour merge ? (1 ou 2 reviewers ? validation en réunion ?)

Je pense que l'écriture des features BDD doit avoir la même approche : d'abord un PR, relecture et validation collégiale.

Qu'en pensez-vous ??

Peut-on aussi commencer à écrire et discuter du worklow git : à minima: - quand créer un pull request - que doit contenir le pull request pour être acceptable (nouveaux tests, tests OK, doc) - accord pour merge ? (1 ou 2 reviewers ? validation en réunion ?) Je pense que l'écriture des features BDD doit avoir la même approche : d'abord un PR, relecture et validation *collégiale*. Qu'en pensez-vous ??
Author
Member

Philippe,

j'avais commencé un chapitre ici : https://git.pdplibre.org/Construction_PA/PA_Communautaire/src/branch/main/docs/developpement/Contribuer.md#cycle-de-contribution

Je vais commencer des tutos pour faire de jolis tests avec ce que tu nous a montré aujourd'hui:

  • Comment rédiger un test BDD quand on est un expert métier ?
  • Comment programmer un test BDD ?

ça va se passer là:

Je n'ai pas l'habitudeu de ForgeJo, je connais bien Gitlab. J'espère qu'on peut faire des templates pour les tickets.

Philippe, j'avais commencé un chapitre ici : https://git.pdplibre.org/Construction_PA/PA_Communautaire/src/branch/main/docs/developpement/Contribuer.md#cycle-de-contribution Je vais commencer des tutos pour faire de jolis tests avec ce que tu nous a montré aujourd'hui: * Comment rédiger un test BDD quand on est un expert métier ? * Comment programmer un test BDD ? ça va se passer là: - https://git.pdplibre.org/Construction_PA/PA_Communautaire/src/branch/main/docs/developpement/Test.md - https://git.pdplibre.org/Construction_PA/PA_Communautaire/src/branch/main/docs/developpement/Test_Howto_BDD.md Je n'ai pas l'habitudeu de ForgeJo, je connais bien Gitlab. J'espère qu'on peut faire des templates pour les tickets.
Author
Member

@philippe.entzmann

J'ai trouvé la technique pour faire des templates de tickets.

On peut faire des tempaltes en markdown, mais on peut aussi faire des formulaires avec des champs, des listes etc ...

Idem pour les pull request.

@philippe.entzmann J'ai trouvé la technique pour faire des templates de tickets. On peut faire des tempaltes en markdown, mais on peut aussi faire des formulaires avec des champs, des listes etc ... Idem pour les pull request.

Je n'ai pas l'habitudeu de ForgeJo, je connais bien Gitlab. J'espère qu'on peut faire des templates pour les tickets.

Moi aussi j'avais un faible pour gitlab 🥹

> Je n'ai pas l'habitudeu de ForgeJo, je connais bien Gitlab. J'espère qu'on peut faire des templates pour les tickets. Moi aussi j'avais un faible pour gitlab 🥹

@f.piccinali wrote in #2 (comment):

j'avais commencé un chapitre ici : https://git.pdplibre.org/Construction_PA/PA_Communautaire/src/branch/main/docs/developpement/Contribuer.md#cycle-de-contribution

👍
il faudra discuter assez vite en réunion des critères pour valider (merger) ou refuser/attendre un PR.

en attendant on va valider les premiers PR sauvagement 😜

@f.piccinali wrote in https://git.pdplibre.org/Construction_PA/PA_Communautaire/issues/2#issuecomment-48: > j'avais commencé un chapitre ici : https://git.pdplibre.org/Construction_PA/PA_Communautaire/src/branch/main/docs/developpement/Contribuer.md#cycle-de-contribution > 👍 il faudra discuter assez vite en réunion des critères pour valider (merger) ou refuser/attendre un PR. en attendant on va valider les premiers PR sauvagement 😜
Author
Member

Mémo pour moi:

A voir ensemble:

Bonnes pratiques - démarrer rapidement

  • recommander les plugins VSCode : python, pytest, docker, yaml ...

Doc docker:

  • est il necessaire d'être root pour lancer docker ? : voir rootless ou user dans group docker ou podman

  • verifier la commande pour vérifier le clone

  • doc PR + template

  • doc bug + template

Mémo pour moi: A voir ensemble: - forgejo - [x] - les labels - [x] - [les projets et le kanban](https://git.pdplibre.org/Construction_PA/PA_Communautaire/projects) - [ ] - nettoyer [les pulls](https://git.pdplibre.org/Construction_PA/PA_Communautaire/pulls) - [x] - nettoyer [les branches terminées](https://git.pdplibre.org/Construction_PA/PA_Communautaire/branches) - nouveaux tickets - [ ] - #10 ci/cd - processes : - [ ] - comment valider une PR ? Qui a autorité pour le main ? - [ ] - milestones et/ou projets ? # Bonnes pratiques - démarrer rapidement - recommander les plugins VSCode : python, pytest, docker, yaml ... Doc docker: * est il necessaire d'être root pour lancer docker ? : voir rootless ou user dans group docker ou podman * verifier la commande pour vérifier le clone * doc PR + template * doc bug + template
Member

J'ai parcouru les documents existants. Beau travail déjà !

Et j'ai vu les deux guides suggérés par @f.piccinali et je me suis essayé sur la rédaction assistée avec une IA. Le résultat est dans la branche docs/bdd-guides
A améliorer de toute façon et voir si la démarche IA est acceptable.

J'ai parcouru les documents existants. Beau travail déjà ! Et j'ai vu les deux guides suggérés par @f.piccinali et je me suis essayé sur la rédaction assistée avec une IA. Le résultat est dans la branche docs/bdd-guides A améliorer de toute façon et voir si la démarche IA est acceptable.
Author
Member

@philippe.entzmann

Philippe,
je viens de merger sur la main les docs de bruno et j'ai revu la navigation dans la docs.

Mon niveau de compréhension ne me permet pas de tout comprendre. Peux tu y jeter un oeil avant notre réunion pour voir si c'est compréhensible.

cf https://git.pdplibre.org/Construction_PA/PA_Communautaire/src/branch/main/docs/developpement/BDD_README.md et les 2 pages liées

D'avance merci

Je ferais les mise à jour que tu me diras mardi

@philippe.entzmann Philippe, je viens de merger sur la main les docs de bruno et j'ai revu la navigation dans la docs. Mon niveau de compréhension ne me permet pas de tout comprendre. Peux tu y jeter un oeil avant notre réunion pour voir si c'est compréhensible. cf https://git.pdplibre.org/Construction_PA/PA_Communautaire/src/branch/main/docs/developpement/BDD_README.md et les 2 pages liées D'avance merci Je ferais les mise à jour que tu me diras mardi
Member

Je vous mets en PJ le skill utilisé dans Claude qui embarque 4 fichiers de référence sur

  • references/gherkin-syntax.md - Complete Gherkin language reference
    
  • references/step-definitions.md - Step definition patterns by language
    
  • references/hooks-config.md - Hooks, configuration, and runners
    
  • references/best-practices.md - Anti-patterns and advanced patterns
    

A voir comment les utiliser ou pas.

Je vous mets en PJ le skill utilisé dans Claude qui embarque 4 fichiers de référence sur - references/gherkin-syntax.md - Complete Gherkin language reference - references/step-definitions.md - Step definition patterns by language - references/hooks-config.md - Hooks, configuration, and runners - references/best-practices.md - Anti-patterns and advanced patterns A voir comment les utiliser ou pas.
Author
Member

Mémo pour moi

TODO:

  • mettre en face à face les docs tests métier et dev
  • re-tester le nouveau docker et mettre à jour la doc
  • tester et expliquer
copy secret.example secret
docker compose run test-bdd

docker composer build
docker compose push

docker compose up

edition en live
Mémo pour moi TODO: * mettre en face à face les docs tests métier et dev * re-tester le nouveau docker et mettre à jour la doc * tester et expliquer ``` copy secret.example secret docker compose run test-bdd docker composer build docker compose push docker compose up edition en live ```
Member

Le build est que si on change des choses dans un Dockerfile.
Le push est critique. On fait un push que si on veut déployer l'image au monde. Le push devrait être fait, qu'au moment du déploiement, lorsque le Dockerfile arrive sur un branch main par exemple.

Si on veut utiliser les images hébergées sur https://git.pdplibre.org/Construction_PA/ il faut faire un :

docker login git.pdplibre.org

Le login et le mot de passe sont les identifiants que vous utilisez pour https://git.pdplibre.org.

Résumé des commandes

# Création du fichier secret pour les variables d'environnement secret
copy secret.example secret

# La premier fois il faut s'identifié sur le repo d'image
docker login git.pdplibre.org

# Démarre tous les containers, sauf test-bdd qui est dans un profils
docker compose up

# Pour lancé les testes 
docker compose run test-bdd

# Pour stopé tous les containers
docker compose stop

# Pour supprimé tous les containers et leurs volume
docker compose down -v

# Pour builder les images (on fait en premier 01-api-gateway, car tous les autres en dépende)
docker compose build 01-api-gateway
docker compose build

# Pour publié les images
docker compose push
Le build est que si on change des choses dans un Dockerfile. Le push est critique. On fait un push que si on veut déployer l'image au monde. Le push devrait être fait, qu'au moment du déploiement, lorsque le Dockerfile arrive sur un branch main par exemple. Si on veut utiliser les images hébergées sur https://git.pdplibre.org/Construction_PA/ il faut faire un : ```bash docker login git.pdplibre.org ``` Le login et le mot de passe sont les identifiants que vous utilisez pour https://git.pdplibre.org. Résumé des commandes ```bash # Création du fichier secret pour les variables d'environnement secret copy secret.example secret # La premier fois il faut s'identifié sur le repo d'image docker login git.pdplibre.org # Démarre tous les containers, sauf test-bdd qui est dans un profils docker compose up # Pour lancé les testes docker compose run test-bdd # Pour stopé tous les containers docker compose stop # Pour supprimé tous les containers et leurs volume docker compose down -v # Pour builder les images (on fait en premier 01-api-gateway, car tous les autres en dépende) docker compose build 01-api-gateway docker compose build # Pour publié les images docker compose push ```
Sign in to join this conversation.
No milestone
No assignees
4 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Construction_PA/PA_Communautaire#2
No description provided.