Skip to content

Latest commit

 

History

History
187 lines (136 loc) · 7.18 KB

README.md

File metadata and controls

187 lines (136 loc) · 7.18 KB

Documentation pour le (futur ?) contributeur/développeur

Devenir contributeur/développeur du projet

Vous voulez devenir contributeur du projet ?

Ou bien vous ne vous sentez pas apte à modifier le code mais vous souhaitez participer à l'élaboration de la documentation en ligne ?

Rien de plus simple, il suffit de suivre les deux étapes suivantes :

1ère étape : Vous vous créez un compte Github. L'inscription se fait à cette page.

Cela prend 5 minutes, c'est une inscription on ne peut plus classique : on fournit un identifiant, un mot de passe et une adresse email, on reçoit un mail de confirmation pour activer son compte Github, etc.

Si vous êtes inscrit(e) sur la liste de diffusion gnu-linux_et_se3, choisissez comme adresse email sur Github l'adresse email sur laquelle vous recevez les messages de la liste de diffusion (voir plus bas les explications sur ce point).

2ème étape : Faites savoir que vous voulez devenir membre du projet SambaEdu en écrivant à l'adresse mail indiquée dans ce fichier au niveau du champ Maintainer:.

Dans votre mail, indiquez bien le login de votre compte Github afin que l'on sache le nom du compte qui doit être intégré au projet. Nous vous répondrons par mail dès que possible pour vous indiquer que vous êtes bien désormais habilité(e) à contribuer au projet.

Memo sur Git et le formatage markdown

Maintenant que vous avez bien procédé aux deux étapes ci-dessus, vous êtes apte à contribuer au projet.

Mais comment contribuer en pratique ?

Comme vous pouvez le constater, le projet est géré par Git (un logiciel de « gestion de code source », on dit aussi de « versionning de code source »). Github, lui, n'est qu'un site web permettant surtout de visualiser le projet (et de lui donner une visibilité publique).

Mais la modification du projet, elle, se fait sur votre machine en local avec le logiciel Git (donc on utilise Git pour gérer un projet sous Github, jusqu'ici ça se tient).

L'utilisation de Git pour des tâches courantes (typiquement modifier/ajouter un fichier) est beaucoup plus simple qu'il n'y paraît. Il existe de nombreux tutoriels sur Git dans le Web. Nous vous proposons également un petit memo ici qui devrait vous permettre de bien débuter.

Une fois que vous en saurez suffisamment sur Git, vous serez par exemple en mesure d'écrire des pages de documentation, exactement comme celle que vous êtes en train de lire présentement, en utilisant la syntaxe markdown. Markdown est une syntaxe vraiment très simple utilisée par Github (entre autres) afin de mettre en forme du texte (elle ressemble beaucoup aux syntaxes que l'on rencontre sur certains sites de type Wiki). Vous trouverez un résumé de l'essentiel de cette syntaxe markdown ici.

Le channel IRC #se3

Si vous êtes motivé(e)s pour contribuer mais que rencontrez des difficultés techniques, n'hésitez pas à demander de l'aide sur IRC (protocole de communication par messages instantanés).

Une discussion en directe est parfois plus rapide et plus efficace qu'un échange par mails pour dépanner quelqu'un. Un channel #se3 est disponible sur le serveur irc.crdp.ac-versailles.fr (port 6667).

Pour vous connecter, il faut d'abord que vous installiez un client IRC sur votre machine.

Voici un guide très rapide pour y arriver si vous êtes sur un système d'exploitation de type Debian ou Ubuntu. D'abord vous installez le client IRC pidgin (il existe plein d'autres clients IRC) en lançant les deux commandes suivantes :

# Soit en tant que root ou alors avec sudo devant chaque commande.
apt-get update
apt-get install pidgin

Vous pouvez alors lancer le programme pidgin fraîchement installé et, ensuite, il vous suffira de suivre les instructions indiquées dans la vidéo ci-dessous (qui dure 1 minute environ) :

  • la vidéo est disponible ici au format mp4. Vous pouvez la télécharger (la vidéo ne fait que 4 Mo environ) en faisant un clic droit + "enregistrer sous" au niveau du bouton Raw (à droite de la page).
  • la vidéo est disponible ici au format ogv. Vous pouvez la télécharger (la vidéo ne fait que 1 Mo environ) en faisant un clic droit + "enregistrer sous" au niveau du bouton Raw (à droite de la page).

Envoyer une notification de ses commits sur la liste gnu-linux_et_se3

Vous trouverez toutes les explications nécessaires à cette page.

Un exemple de configuration vim pour éditer le code

Avec cette exemple de configuration au niveau de votre fichier ~/.vimrc :

  • la touche tabulation entraînera automatiquement la saisie de 4 espaces (qui est, par convention, le nombre d'espaces pour l'indentation dans du shell),
  • Le caractère (nuisible) espace insécable sera visible explicitement,
  • Le caractère tabulation (à remplacer par 4 espaces) sera visible explicitement,
  • Les espaces en fin de lignes (totalement inutiles) seront visible explicitement.

Voici la configuration du fichier .vimrc :

set tabstop=4
set shiftwidth=4
set expandtab
set listchars=nbsp:¤,tab:>-,trail:·
set list

Points annexes spécifiques au package se3-clients-linux

Comment construire le package se3-clients-linux.deb ?

Vous trouverez toutes les explications nécessaires à cette page.

Dépôt APT de test pour le paquet se3-clients-linux et branche Git

Il existe un dépôt Debian APT de test qui vous permet de tester le paquet se3-clients-linux dans sa dernière version.

Le dépôt est mis à jour toutes les 5 minutes.

Évidemment c'est pour du test, aucune stabilité n'est garantie. Vous trouverez toutes les explications nécessaires à cette page.

La boîte à outils lib.sh

lib.sh est un fichier qui contient toute une série de fonctions shell qui peuvent être réutilisables dans différents scripts du paquet se3-clients-linux.

Vous trouverez plus d'explications à cette page.