Licence CC BY

Zeste de Savoir participe au Hacktoberfest 2023

Octobre est le mois idéal pour contribuer au projet technique !

Comme tous les ans depuis 2014, l’hébergeur Digital Ocean et ses partenaires organisent 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à. ;)

Logo Hacktoberfest figurant un H pixelisé entouré d'un cercle pointillé, accompagné du texte "Hacktoberfest 10"
Bannière Hacktoberfest 2023, pour sa dixième édition (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 !

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 de la communauté ou le forum Dev Zone. Si vous avez des problèmes, des questions, nous sommes là !

Trouvez 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 » à 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 !

Faire compter ses contributions pour le Hacktoberfest

Pour faire des contributions à Zeste de Savoir et qu’elles comptent pour le Hacktoberfest, c’est très simple :

  • S’inscrire sur la plateforme entre le 26 septembre et le 31 octobre, via votre compte GitHub.
  • Soumettre vos pull requests sur le dépôt GitHub de Zeste de Savoir entre le 1 et le 31 octobre.
  • Les mainteneurs du dépôt (les auteurs de ce billet notamment) marqueront vos contributions comme acceptées pour le Hacktoberfest. Elles ne seront pas forcément fusionnées pendant le mois d’octobre, mais elles compteront pour l’événement.

Si vous êtes dans les premiers 50 000 participants à l’événement à atteindre 4 pull requests, vous aurez droit à un arbre planté pour votre compte en guise de récompense. Tous les participants avec 4 pull requests auront aussi droit à une récompense numérique unique. Cette année, pas de t-shirts comme les années précédentes, pour des raisons de coûts, de difficultés logistiques et d’impact écologique.

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

2 commentaires

Voilà, le Hacktoberfest 2023 est terminé depuis maintenant une semaine !

Le dépôt a connu 23 PR ce mois-ci. C’est bien plus qu’un mois normal1 ! Les gens motivés étaient les suspects habituels du développement de Zeste de Savoir : @Situphen, @philippemilink, @artragis et moi-même. Cette année, pas de nouvelles personnes se sont mouillées les pieds pour ce Hacktoberfest. ^^

Encore une fois, s’y mettre à plusieurs crée une certaine émulation. Il est assez motivant d’avoir la QA rapidement et de voir son travail fusionné dans la version de dév promptement. De quoi alimenter l’idée qu’un hackathon pourrait être une manière sympathique d’avancer le développement de Zeste de Savoir.

Le sujets principaux qui ont été traités par les PR du mois d’octobre :

  • de la maintenance importante, mais peu visible pour les visiteurs du site : profiter des dernières versions de nos dépendances, des mises à jours de sécurités, etc ;
  • la préparation pour Django 4.2, essentiellement invisible aussi : actuellement, on utilise Django 3.2, mais on n’aura plus de support à partir du printemps prochain, il faut donc faire le travail nécessaire pour que la mise à jour soit possible sans trop de cahots ;
  • avancée du travail lié au groupe de travail "Organisation des publications" : pour l’instant peu visible, mais l’impact sera majeur à l’aboutissement de ce gros projet ;
  • d’autres petites améliorations de qualité de vie pour les utilisateurs (amélioration d’UX dans l’administration des Unes, le changement du tri par défaut des publications sur la page d’un auteur et quelques autres encore).

Merci à tous les contributeurs et à l’année prochaines pour le prochain Hacktoberfest ! Et bien sûr avant aussi c’est possible. Le développement est ouvert à tous, quelque soit le niveau et les capacités techniques. L’équipe est disponible sur le canal #développement-de-zds du serveur Discord de la communauté.

  1. Cela reste un mois d’Hacktoberfest normal. On a compté 14 PR en 2022 , 17 en 2021, 45 en 2020, 17 en 2019. Sachant qu’il peut aussi y avoir de la variabilité d’activité non liée au Hacktoberfest dans ces chiffres.↩
+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