Une liste de contrôle et un guide pour préparer votre référentiel à la collaboration

DEV - 18/09
Dans le monde du développement logiciel, la collaboration peut faire la différence entre une version fragile de dernière minute et un projet fiable, maintenable et sans problème. Que vous codez depuis un jour ou une décennie, vos collègues sont là pour vous aider à renforcer votre travail. Mais ils ne peuvent vous aider que si vous leur donnez les outils nécessaires.
Vous voulez le TL;DR, ou vous utilisez déjà GitHub depuis un certain temps ? Passez à la fin pour une liste de contrôle imprimable que vous pouvez utiliser pour vous assurer que vous avez couvert tous les aspects de la préparation de votre référentiel à la collaboration.

Ma fille a une paire de gerbilles de compagnie. Ce sont des créatures géniales, mais pas les plus complexes à entretenir. Ils ont besoin que leur cage soit nettoyée de temps en temps, que leur nourriture et leur eau soient remplies, et qu'ils aient peut-être besoin d'un voisin pour les surveiller si nous sommes absents pendant un certain temps. Mais un jour, elle aura peut-être un animal de compagnie qui nécessite plus de soins et d'attention – un chat ou un chien peut-être, avec lequel il faut jouer et s'occuper tous les jours – alors elle voudra avoir quelques bons amis qui connaissent son animal et peuvent l'aider. leur compagne chaque fois qu'elle est absente. Et un jour, elle aura peut-être même un enfant, ce qui rendra ses liens avec la communauté et la famille encore plus importants. Comme le dit le proverbe, il faut tout un village pour élever un enfant.

Il en va de même pour les projets de code. Mes collègues et moi qualifions souvent nos projets d'« animaux de compagnie » ou même d'« enfants » (parfois en plaisantant, parfois de manière obsessionnelle). Nous leur accordons beaucoup de soin et d’attention, mais il peut être facile d’oublier à quel point les contributions de la communauté peuvent être importantes pour leur réussite. Dans le monde du développement logiciel, la collaboration peut faire la différence entre une version fragile de dernière minute et un projet fiable, maintenable et sans problème. Que vous codez depuis un jour ou une décennie, vos collègues sont là pour vous aider à renforcer votre travail. Mais ils ne peuvent vous aider que si vous leur donnez les outils nécessaires.

Votre principale responsabilité en tant que créateur ou responsable d'un référentiel est de garantir que les autres peuvent utiliser, comprendre et même contribuer de manière appropriée au projet. GitHub est là pour soutenir cette mission, mais s'assurer qu'un référentiel est prêt pour la collaboration demande un peu plus d'efforts que d'utiliserclone git. Alors poursuivez votre lecture pour découvrir les paramètres, le contenu et les comportements qui vous aideront à réussir.

1. Paramètres du référentiel

Les paramètres de votre référentiel jettent les bases de la collaboration. Ils déterminent qui peut voir et contribuer à votre projet, comment les contributions sont examinées et ce qu'il advient de ces contributions une fois soumises. Correctement utilisés, ils peuvent favoriser un environnement dans lequel les contributeurs du monde entier trouveront, utiliseront et aideront à construire votre projet. Dans un environnement d'entreprise, ils aident les développeurs à passer d'une façon de penser et de construire cloisonnée à un état d'esprit « la recherche d'abord, la collaboration d'abord ». Cette pratique, connue sous le nom d’innersourcing, réduit le travail redondant et accélère l’ensemble de l’entreprise.

Visibilité

Vous souhaitez maximiser les contributions et la réutilisation, mais cela ne signifie pas toujours rendre votre référentiel public, en particulier dans un environnement d'entreprise où la confidentialité des ...
[Courte citation de 8% de l'article original]

Loading...