[FEATURE] Ajout d'une règle forcant l'ajout d'un commentaire sur les colonnes. #25
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
VincentHardouin
force-pushed
the
add-no-column-migration-without-comment
branch
3 times, most recently
from
bd02646
to
bc5cc28
Compare
MathieuGilet
approved these changes
Jul 16, 2024
yannbertrand
approved these changes
Jul 16, 2024
|
je suis ci |
VincentHardouin
added
Tech Review OK
🚀 Ready to Merge
and removed
👀 Tech Review Needed
labels
Co-authored-by: Mathieu Gilet <mathieu.gilet@pix.fr>
pix-service-auto-merge
force-pushed
the
add-no-column-migration-without-comment
branch
from
bc5cc28
to
06f501a
Compare
pix-service-auto-merge
pushed a commit
that referenced
this pull request
Jul 16, 2024
# [1.3.0](v1.2.2...v1.3.0) (2024-07-16) ### 🚀 Amélioration - [#25](#25) Ajout d'une règle forcant l'ajout d'un commentaire sur les colonnes.
|
🎉 This issue has been resolved in version 1.3.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This was referenced Jul 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🦄 Problème
Dans le but de faciliter la compréhension des nos modèles de données, il est préférable d'ajouter une description à nos colonnes. Knex permet de le faire grâce à la fonction
comment(). Afin d'éviter les oublis, nous avons décider d'ajouter une règle de lint qui empêche l'ajout ou la modification d'une colonne sans ajouter de commentaire.🤖 Proposition
Ajouter une règle de lint forçant l'ajout d'un commentaire.
🌈 Remarques
Il faudra désactiver la règle sur les anciennes migration (
npx suppress-eslint-errors@2.0.4 . --rules=@1024pix/no-column-migration-without-comment)💯 Pour tester
Vérifier que les test passent (la règle a été testée sur le code du mono repo).