Il y a deux suggestions populaires ici:
git branch --edit-description
: Nous n'aimons pas cela parce que vous ne pouvez pas le pousser. Peut-être que je peux me souvenir de ce que font les branches que j'ai créées, mais mon équipe ne le peut certainement pas.
README
fichier pr. branche. C'est une douleur pendant les fusions: super-enclin à fusionner les conflits et nous tirerons README
des branches lorsque nous fusionnerons les branches de fonctionnalités. Les différences entre les branches sont également une douleur.
Nous avons décidé de créer une branches-readme
branche orpheline . Les branches orphelines sont des branches avec leur propre histoire distincte - vous les connaissez peut-être dans les gh-pages
branches de Github . Cette branche orpheline contient un seul README
fichier. Il a des contenus comme:
master:
The default branch
mojolicious:
Start using Mojolicious
branch-whatever:
Description of the whatever branch
Il est poussable et convivial. Visualisez le README
depuis n'importe quelle branche avec:
git show branches-readme:README
Les inconvénients sont que vous devez extraire la branche orpheline étrange lorsque vous souhaitez mettre à jour le README
et README
ne se met pas automatiquement à jour lorsque les branches sont renommées, vont ou viennent. C'est bien pour nous, cependant.
Faites comme:
git checkout --orphan branches-readme
# All the files from the old branch are marked for addition - skip that
git reset --hard
# There are no files yet - an empty branch
ls
vi README
# put in contents similar to above
git add README
git commit -m "Initial description of the branches we already have"
git push origin branches-readme
# get all your original files back
git checkout master
De même, les membres individuels de l'équipe peuvent également créer leurs propres branches-$user
branches orphelines décrivant leurs propres branches privées s'ils le souhaitent, tant qu'ils ne les poussent pas vers l'équipe.
Avec un outillage supplémentaire, cela pourrait également être intégré à la sortie de git branch
. À cette fin, un README.yaml
dossier pourrait peut-être être envisagé au lieu d'une simple README
.