Projet

Général

Profil

Proposition Scénario #14685

wiki/GitBonnesPratiques : rédiger de façon plus concise avec une langage plus neutre

Ajouté par Klaas TJEBBES il y a plus de 8 ans. Mis à jour il y a plus de 8 ans.

Statut:
À formaliser
Priorité:
Normal
Assigné à:
-
% réalisé:

0%

Temps passé:

Description

Afin de faciliter la compréhension des contributeurs, je pense aux contributions sur wpkg-package, il faudrait revoir la page :
https://dev-eole.ac-dijon.fr/projects/eole/wiki/GitBonnesPratiques

Les informations qu'elle contient sont pertinentes mais trop "habillées/romantique".

Cette page devrait :
  • utiliser un ton plus neutre ("Trop de pull, c’est trop chaud !" ne convient pas pour une documentation technique)
  • être plus concis :
    Que se passe-t-il si un jour nous souhaitons apprendre les nouvelles
    histoires de par le monde ?
    
    Que ce passe-t-il si un jour nous souhaitons partager nos petites
    histoires avec le reste du monde ?
    
    La plupart du temps, la réponse donnée à ces questions commence par
    quelque chose comme « fais-toi donc un pull ».
    

    doit pouvoir se résumer en quelques mots.

Bref, faire une page qui soit lisible, technique et concise.

Dans l'état actuel, les utilisateurs (novices en "git") qui lisent cette page ont plutôt tendance à fuir qu'à essayer de comprendre, c'est dommage...

Historique

#1 Mis à jour par Gérald Schwartzmann il y a plus de 8 ans

  • Tracker changé de Demande à Proposition Scénario
  • Catégorie mis à Version mineure

Cette page wiki était au départ à destination de l'équipe.

Selon la méthode décidé en équipe l'autre jour, les demandes internes ne se font plus dans le tracker demande :
https://dev-eole.ac-dijon.fr/projects/modules-eole/wiki/Gestion_des_demandes_entrantes

Je la déplace donc.

Une page wiki sur le projet wpkg-package pour les contributeurs à wpkg-package serait plus judicieux, à discuter.

#2 Mis à jour par Gérald Schwartzmann il y a plus de 8 ans

  • Projet changé de Distribution EOLE à wpkg-package
  • Catégorie Version mineure supprimé
  • Statut changé de Nouveau à À formaliser

#3 Mis à jour par Klaas TJEBBES il y a plus de 8 ans

Aujourd'hui les contributions se font essentiellement sur wpkg-package mais pas seulement.

Je pense également à "demain", à une page généraliste expliquant les manipulations de bases :
  • configuration git
  • git checkout/pull/commit/push
  • git branch
  • git merge
  • git log (git log --all --pretty=format:"%h %cd %s (%an)" --since='7 days ago')
  • git status
  • git add/rm/mv
  • git hist (git hist master --all)
  • git tag
  • git reset
  • git revert
  • autre ?

Formats disponibles : Atom PDF