Merci beaucoup pour votre volonté de contribuer à ce projet !
Important
Veuillez suivre ces directives pour garantir une collaboration harmonieuse avec l’ensemble de la communauté.
Pour les corrections de bogues et de fautes de frappe, veuillez suivre ces étapes :
- Faites vos modifications directement sur la branche beta.
- Effectuez un commit en suivant la spécification Conventional Commits en
utilisant le type "fix" et en incluant une description claire du correctif, par
exemple :
fix: résoudre le plantage dû à une méthode obsolète
. Ou un PR depuis votre fork.
Pour l'ajout de nouvelles fonctionnalités, veuillez suivre ces étapes :
- Créez une issue décrivant la fonctionnalité que vous souhaitez ajouter.
- Utilisez le bouton "Créer une branche" directement inclus dans l'issue pour créer une nouvelle branche basée sur la branche beta. (Si vous n'avez pas les droits pour créer une branche sur ce dépôt, créez une branche localement sur votre fork du dépôt. Et faire un lien dans l’issue).
- Implémentez la fonctionnalité.
- Effectuez les commits en suivant la spécification Conventional Commits en
utilisant le type "feat" et en incluant une description claire de la nouvelle
fonctionnalité, par exemple :
feat: ajouter une nouvelle méthode duplicate a la class eqLogic
.- Si votre fonctionnalité inclut des changements dans la documentation, ajoutez
un commit supplémentaire avec le type "docs" et une description appropriée,
par exemple :
docs: mettre à jour la documentation pour inclure la nouvelle méthode
. - Si votre fonctionnalité inclut des changements qui affectent les utilisateurs et
méritent d'être mentionnés dans le changelog, ajoutez un commit
supplémentaire avec le type "chore" et une description appropriée, par
exemple :
chore: mettre à jour le changelog pour la version x.x.x
.
- Si votre fonctionnalité inclut des changements dans la documentation, ajoutez
un commit supplémentaire avec le type "docs" et une description appropriée,
par exemple :
- Soumettez une pull request vers la branche beta.
- Attendez la validation.
Pour les commits de type "refactor", "docs", "test" et "chore", veuillez suivre les mêmes étapes que pour les fonctionnalités, en remplaçant le type de commit par celui approprié et en fournissant une description adaptée à la nature du changement, comme décrit ci-dessous :
Tip
- refactor: refactorisation du code, par exemple :
refactor: migrer des composants de classe vers les hooks
. - docs: modifications dans la documentation, par exemple :
docs: ajouter un exemple d'utilisation pour le module
. - test: ajouter ou mettre à jour des tests, par exemple :
test: ajouter des tests d'intégration utilisant detox
. - chore: changements dans le changelog, par exemple :
chore: changement du changelog
.
Thank you very much for your willingness to contribute to this project! Please follow these guidelines to ensure smooth collaboration with the entire community.
To correct bugs and typos, please follow these steps:
- Make your changes directly on the beta branch.
- Make a commit following the Conventional Commits specification, using the type using the "fix" type and including a clear description of the fix, for example for example: "fix: resolve crash due to obsolete method". Or a PR from your fork.
To add new features, please follow these steps:
- Create an issue describing the feature you wish to add.
- Use the "Create a branch" button directly included in the issue to create a new branch based on the beta branch. (If you do not have rights to create a branch on this repository, create a branch locally on your your fork of the repository. And make a link in the issue).
- Implement the functionality.
- Make the commits following the Conventional Commits specification, using the
type "feat" and including a clear description of the new functionality, for example
functionality, for example: "feat: add a new duplicate method
to the eqLogic class.
- If your functionality includes changes to the documentation, add an additional commit with the type "docs" and an appropriate description, for example: "docs: update the documentation to include the new method".
- If your functionality includes changes that affect users and deserve to be deserve to be mentioned in the changelog, add an additional commit with the type "chore" and an appropriate description, for example example: "chore: update changelog for version x.x.x".
- Submit a pull request to the beta branch.
- Wait for validation.
For "refactor", "docs", "test" and "chore" commits, please follow the same steps as for the same steps as for features, replacing the commit type with the appropriate one the appropriate one and providing a description adapted to the nature of the change, as described below:
- refactor: refactor the code, for example: ``refactor: migrate components to hooks.
- docs: changes to the documentation, for example: ``docs: add a example for the module.
- test: add or update tests, for example:
test: add integration tests using detox
. integration tests using detox``. - chore: changes to the changelog, for example:
chore: change of the changelog
.