This guide covers the basics of how to contribute to the Assemblyline project.
Python code should follow the PEP8 guidelines defined here: PEP8 Guidelines.
Before you start coding anything you should connect with the Assemblyline community via the Assemblyline Discord server and/or the central Assemblyline GitHub project to make sure no one else is working on the same thing and that whatever you are going to build still fits with the vision of the system.
- Clone the repo to your own account
- Checkout and pull the latest commits from the master branch
- Make a branch
- Work on your modifications and make sure your changes work as expected
- When you're satisfied with your changes, create a pull requests to the Assemblyline repo
If you've worked on a new service that you want to be included in the default service selection you'll have to transfer the associated repo into our control.
Even if you try to merge in your pull request, you will be denied. Only a few people in our team are allowed to merge code into our repositories.
We check for new pull requests every day and will merge them in once they have been approved by someone in our team.
Ce guide couvre les bases de la façon de contribuer au projet Assemblyline.
Le code Python doit suivre les directives PEP8 définies ici: Directives PEP8.
Avant de commencer à coder quoi que ce soit, vous devriez vous connecter à la communauté Assemblyline via le Serveur Discord Assemblyline et/ou le projet GitHub central Assemblyline pour vous assurer que personne d'autre ne travaille sur la même chose et que tout ce que vous allez construire correspond toujours à la vision du système.
- Clonez le référentiel sur votre propre compte
- Changez de branche pour la branche principale et la synchroniser avec le serveur de référence
- Faire une nouvelle branche
- Travaillez sur ce que vous souhaitez et assurez-vous que vos modifications fonctionnent comme prévu
- Lorsque vous êtes satisfait de vos modifications, créez une demande de fusion sur le référentiel d'Assemblyline
Si vous avez travaillé sur un nouveau service que vous souhaitez inclure dans la sélection de service par défaut, vous devrez transférer le référentiel associé sous notre contrôle.
Même si vous tentez de compléter une demande de fusion, vous serez refusé. Seules quelques personnes de notre équipe sont autorisées à fusionner dans nos référentiels.
Nous vérifions les nouvelles demande de fusion tous les jours et les fusionnerons une fois qu'elles auront été approuvées par quelqu'un de notre équipe.