Agregio Design System (Storybook and package generation)

⚠️ Warning: this file is probably the most important in this project. Please read it carefully before committing anything. Thanks ! 🙏

Contributing

This documentation only concerns devs that want to contribute to the project.

If you are looking for documentation on using our component library, please refers to the Zeroheight documentation instead.

Installation

git clone <repo-url>
cd storybook-for-DS
npm install
npm run prepare

npm run prepare est nécessaire car ignore-scripts=true est configuré dans .npmrc, ce qui empêche l'exécution automatique du script prepare après npm install. Sans cette étape, les hooks Husky (pre-commit) ne seront pas installés.

Summary

• Styling components: everything you need to know about styling components.
• Updating dependencies: if you need to update the front-end dependencies.
• Available scripts: if you have installed the front-end and want to know about the available npm scripts.
• Git flow & deployment process: if you need to deploy a new release of the front-end or understand how our CI/CD works.
• Commit message convention: if you want to write consistent and magic commit messages 🪄
• Code Quality: if you want to hear about the tools and practices chosen to ensure a good Code Quality.
• Managing Icons: if you want to add, update or delete an icon from the Icon component.
• Publish package on NPM: if you want to know how we publish our package on NPM.
• Troubleshooting: ressources on bugs we had and way to fix them