Contribution
À l'heure actuelle, Bachero est toujours en phase de bêta. Si vous souhaitez contribuer au développement d'un des projets en lien avec Bachero, vous pouvez vous rendre sur le repo GitHub de celui-ci pour y faire une pull request. Avant de proposer vos modifications, assurez vous de finir de lire cette page...
Êtes-vous au bon endroit ?
Si vous souhaitez plutôt créer un module, cliquer ici pour aller à la bonne page.
Si vous n'êtes pas en mesure de contribuer au code, mais que vous avez une idée pour améliorer Bachero, vous pouvez créer une issue sur le repo GitHub associé au bon projet.
Le reste de cette page est dédié à tous les développeurs voulant faire part de leur modifications au code source de Bachero.
Règles à suivre
Certaines règles sont à respecter obligatoirement, pour des raisons assez évidentes :
- Vos modifications ne doivent pas empêcher les autres d'utiliser le code
Si la/les modifications que vous proposez peuvent empêcher un utilisateur de démarrer le projet (exemple : lorsqu'il utilise un certain OS, ou une certaine version de NodeJS), votre pull request risque d'être rejeté.
- Vous ne devez pas voler le code d'autres personnes
Imaginons qu'un utilisateur de la communauté crée un module qui rajoute une fonctionnalité à Bachero, vous ne devriez pas voler son code pour l'ajouter à votre PR, surtout si elle vise à être intégré comme une fonctionnalité principale. Si vous souhaitez contribuer à son projet, ouvrez une PR sur le sien.
- Le code doit rester compréhensible
Tout le monde a le droit d'avoir un style de code différent (oui, même ceux qui indentent avec des espaces), mais les modifications que vous proposez doivent rester facilement lisible. Le fait d'utiliser un obfuscateur ou autre outil visant à complexifier la lecture risque de vous faire rejeter. Tenter d'utiliser un style que la plupart des gens peuvent rencontrer au quotidien.
- Ne pas proposer de modules
Vous pouvez créer des modules, et les partager en créant des repos sur votre profil GitHub. Cependant, ne tentez pas de les proposer directement dans le code source du robot. Malgré ça, il peut y avoir des exceptions et si vous pensez qu'un module pourrait être ajouté à Bachero, vous pouvez tout de même le proposer, en faisant attention à ce qu'il mérite réellement d'être ajouté.
Préparer votre propre instance
Cela ne s'applique que si vous contribuez au code source du robot.
Vous pouvez lire l'introduction pour comprendre comment configurer votre propre instance. Malgré que c'est fortement recommandé pour tester votre code, vous pouvez directement proposer des modifications via une pull request sans rien avoir à préparer.