Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
85 lines (50 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

85 lines (50 loc) · 3.01 KB

Contribuer à DeviensDev

Introduction

DeviensDev est une plateforme d’information sur le métier de développeur. Elle repose intégralement sur un système de contribution. Ainsi, tous les professionnels du développement qui souhaitent partager leurs connaissances, leur vision et leur passion du métier sont invités avec plaisir à contribuer à la plateforme.

Si tu souhaites apporter ta pierre à l’édifice DeviensDev, tu peux écrire un article qui sera publié sur le blog : Parlons Dev !

Pour ce faire, il y a quelques étapes à respecter :

Tu souhaites proposer un article ?

Comment contribuer :

  • Fork le dépôt GitHub fork

  • Crée une branche et tu te positionnes dessus

    • git checkout master
    • git pull origin master pour être sûr d'avoir la dernière version du code
    • git checkout -b le-nom-de-ma-branche (remplace le-nom-de-ma-branche avec un nom approprié) pour créer une branche

  • Crée ton article dans content/blog/*

    • ⚠️ En respectant bien la convention du nom de fichier <date>_<titre>/index.md (par exemple 2018-09-25_devenir-developpeur/index.md)
    • Tu peux t'aider du fichier GUIDELINES.md pour mettre en forme ton article
    • Si jamais tu as un doute, tu peux t'inspirer des autres articles déjà présent

  • Crée un fichier .json dans content/authors/* où tu peux y ajouter ton twitter et ta bio.

    • ⚠️ En respectant bien la convention du nom de fichier qui doit avoir ton pseudo GitHub (par exemple alexandrebourdeaudhui.json)
    • Là aussi, n'hésite pas à t'insipirer de ce que les autres ont déjà fait

Pour tester le rendu de ton article, en local :

  • Installe les dépendances nécessaires au projet
$ yarn install
  • Execute le projet en mode développement
$ yarn start
  • Ouvre le projet sur ton navigateur
$ open http://localhost:8000

Une fois que tout est prêt :

  • Tu commit les modifications de ta branche en local

    • git add -A && git commit -m "Mon message" (remplace Mon message par un nom de commit approprié) pour commiter tes changemens

  • Tu push ta branche locale sur ton dépôt

    • git push -u origin MaBranche (remplace MaBranche par le nom de ta branche)

  • Tu fais une demande de pull-request de ta branche vers notre branche master

  • On fait une relecture de l’article pour corriger les éventuelles fautes d’orthographe

  • Si des points sont à éclaircir, on en discute ensemble

  • On planifie la publication

  • On met en ligne l’article

Tu souhaites corriger un article ?

Si tu souhaites corriger un article déjà en ligne, tu as le choix :

  • Suivre la procédure décrite dans « Tu souhaites proposer un article »
  • Le faire directement depuis l’interface GitHub

Si tu ne sais pas comment t’y prendre…

N’hésite pas à ouvrir une issue sur le dépôt GitHub, et notre équipe viendra te filer un coup de main.