Licence CC BY

Zeste de Savoir participe au Hacktoberfest 2022

Le mois d'octobre est idéal pour faire vos premières contributions au projet technique !

Comme tous les ans depuis quelques années, l’hébergeur Digital Ocean organise la Hacktoberfest ! Derrière cette référence à la fameuse fête de la bière munichoise se cache un événement célébrant l'open source et encourageant à contribuer à vos logiciels open source favoris. Le principe est simple : réussir son Hacktoberfest, c’est faire quatre contributions à des projets open source participants sur le mois d’octobre1.

Cette année encore, le projet technique de Zeste de Savoir, le logiciel qui fait tourner le site que vous êtes en train de lire, participe à l’événement ! Ce billet vous donne les informations essentielles si vous êtes motivés pour contribuer au code ou à la documentation de Zeste de Savoir dans le cadre de la Hacktoberfest, voire au-delà. ;)

Bannière Hacktoberfest 2022 (source).

  1. Je vous réfère au site officiel pour les règles détaillées.

Le projet technique de Zeste de Savoir

Le projet technique de Zeste de Savoir désigne tout ce qui fait tourner le site que vous êtes en train de visiter en ce moment-même. Le cœur du projet est hébergé sur GitHub sur le dépôt zds-site et contient principalement :

  • le backend en Python avec l’utilisation du framework Django ;
  • le frontend en Javascript et SCSS ;
  • la documentation du projet.

Deux autres outils complètent zds-site :

  • zmarkdown, qui permet de faire le rendu de tout ce qui est écrit en Markdown sur le site ;
  • latex-template, qui sert pour l’export PDF de nos publications.

Que vous soyez plutôt Python, Javascript, CSS, ou un adepte de LaTeX, vous trouverez sûrement des choses à votre goût pour contribuer !

Contribuer au projet

Se préparer

La première étape si vous souhaitez contribuer est de s’inscrire sur GitHub si ce n’est pas déjà le cas. Le code de Zeste de Savoir y est hébergé. Pour contribuer efficacement, un compte est indispensable.

La seconde étape consiste à installer l’environnement de développement. Autrement dit à installer le site sur votre ordinateur. La documentation du site fournit des guides pour débuter pas-à-pas ainsi qu’une page consacrée à l’installation avec le détail des instructions nécessaires pour installer l’environnement.

Contactez-nous !

L’installation peut présenter quelques difficultés en fonction des spécificités de votre système. En cas de soucis, n’hésitez pas à nous contacter ! Les contributeurs réguliers de Zeste de Savoir sont disponibles sur le canal #développement-de-zds du serveur Discord non-officiel de la communauté ou le forum Dev Zone.

Trouver votre premier ticket à résoudre

Si vous êtes un nouveau contributeur, les tickets marqués « Facile » sont faits pour vous ! Nous avons concocté une liste de tickets « Facile » restant à résoudre.

Nos tickets « Facile » sont conçus spécifiquement pour vous mettre le pied à l’étrier sur le projet. Ils sont volontairement fournis avec une solution identifiée, ou un début de solution et demandent peu de familiarité avec les entrailles du projet. Idéal pour découvrir le processus de contribution !

Résoudre le ticket et soumettre votre contribution

La résolution du ticket est à votre initiative et dépend du ticket, il n’y a donc pas d’instructions particulières, si ce n’est que tout ce qui touche au Python doit être accompagné de tests unitaires. Dites-nous si vous rencontrez des difficultés, on sera là pour vous aider !

Le projet intègre les mises à jour à travers des pull requests (demande de fusion en français). Une fois que vous êtes satisfaits de votre travail, ou que vous avez envie de recevoir des commentaires sur votre travail en cours, vous pouvez créer une pull request sur le dépôt.

Un membre de l’équipe technique s’assurera de la qualité de celle-ci et vous dira ce qu’il faut modifier si nécessaire. Une fois que tout est bon, elle sera fusionnée au projet !

Merci de prendre connaissance du Code de conduite des contributeurs et de le respecter pour garder ce projet ouvert et accueillant !


Miniature du billet : logo Hacktoberfest 2022, utilisation selon les conditions de Digital Ocean.

3 commentaires

J’ai commencé mon Hacktoberfest !

Cette année, j’ai choisi de me concentrer sur ce que je maîtrise le moins, à savoir le front end. J’ai pour l’instant 5 PR, dont 4 qui touchent au front. Il reste encore à faire pour atteindre mon objectif personnel de 10 PR ce mois-ci !

Il reste encore plein de tickets qui touchent au front de difficulté variable. Pour l’instant, j’ai pris des plus faciles pour pas me décourager, mais qui sait pour la suite. ^^

Le Hacktoberfest touche à sa fin. Je dénombre 14 PR faites en octobre sur le dépôt principal !

J’en profite pour remercier ceux qui ont contribué au côté technique de Zeste de Savoir, que ce soit en rapportant des bugs (sur GitHub ou le forum dédié), en suggérant des évolutions, en faisant des modifications au code (les fameuses PR !), mais aussi les mainteneurs pour leur travail parfois moins visible mais tout aussi important (revue des PR, maintenance du serveur, etc.).

Ce mois d’octobre a été pour certains une occasion de mettre un pied dans le développement de Zeste de Savoir. Merci notamment à @DonKnacki et @MasterZeno pour leur intérêt.


J’ai personnellement atteint mon objectif d’au moins 10 PR pendant ce mois d’octobre ! Finalement, je n’ai pas fait autant de front qu ce que je m’étais promis à moi-même, mais j’ai résolu quelques autres bugs et aussi repris un certain nombre de PR presque abouties mais délaissées par leurs auteurs originaux.

+3 -0
Connectez-vous pour pouvoir poster un message.
Connexion

Pas encore membre ?

Créez un compte en une minute pour profiter pleinement de toutes les fonctionnalités de Zeste de Savoir. Ici, tout est gratuit et sans publicité.
Créer un compte