Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

74 lines (53 loc) · 2.48 KB

How to Contribute

Guidelines for repository contributors

Prérequis techniques

https://guides.github.com/

https://github.com/simplonco/git-training

Nomenclature de nomage

{techno}-{type}-{name}

Les dépots doivent être écrits sous cette forme afin d’uniformiser les catégories et de faciliter le travail de recherche et de référencement au sein de GitHub.

Voici l’exemple d’un nom de repo, il est décomposé en trois parties :

php-workshops-twig

Il contient en première partie le nom de la technologie principale, ensuite il contient en deuxième partie le type de contenu du décrit dans le tableau ci-dessous (vous remarquerez que le nom est toujours au pluriel) :

training Root of GitLab repository for a technology - modules {techno}-training-{name}
resources Currated list of external urls - resources {techno}-resources-{name}
project(s) Long project activity, without tutorial, but some functional / technical specifications, to engage students autonomy {techno}-project(s)-{name}
challenge(s) TDD exercices validated by GitLab CI (cool for algorithms teaching: input => output), can be imported from exercism.io {techno}-challenge(s)-{name}
exercise(s) Exercices given without automated validation, with just a short subject / explanation {techno}-exercise(s)-{name}
workshop(s) Guided tutorial / courses / short code activity {techno}-workshop(s)-{name}

Pour terminer, la troisième partie contient le nom du thème abordé dans ce dépôt.

Il faut essayer d’être simple, fun et facilement compréhensible avec des mots clés pertinents, ex: bootstrap-portfolio, UX-vs-UI, flexminator, send-mail-form, etc...

Créer un identifiant GitHub

Une connexion SSO avec Github est disponible. Nous vous conseillons d’utiliser ce mode de connexion afin de pouvoir facilement importer vos projets de votre compte Github à l’avenir.

Créer son groupe correspondant à sa promotion

https://github.com/orgs/simplonco/teams

Ajouter un apprenant dans son groupe de promotion

Créer un repo dans le groupe principal de simplonco

https://github.com/organizations/simplonco/repositories/new

To be continued..