Meilleures / mauvaises pratiques pour le partage de code? [fermé]

Plus j'explore Github , plus je l'aime. J'aime vraiment à quel point le codage devient plus social.

Je suis curieux de savoir s'il existe des mauvaises pratiques que les programmeurs devraient éviter en partageant leur code entre eux. Et pour nommer les mauvaises pratiques, quelles sont les meilleures pratiques pour le partage de code ?

Par exemple:

Est-ce une mauvaise pratique pour un seul dépôt d'avoir plusieurs scripts / projets nommés 'MiscProjects' ? Où ce dépôt, comme son nom l'indique, est une collection de petits scripts et projets divers. Cela peut ressembler à la façon dont un programmeur organise des projets sur son stockage local, mais ce n'est peut-être pas optimal pour le partage de code?

Peut-être que si un bon README / documentation était fait, ce serait mieux? Ou tant que c'est bien documenté, quelque chose se passe?

Bien qu'il n'y ait pas de «mauvaises pratiques» gravées dans le marbre, de même qu'avec d'autres systèmes de contrôle de version, il existe des conventions .

Votre dépôt Git doit être aussi petit que possible. Si vous venez du module CVS / SVN, il était courant d'avoir un référentiel unique structuré qui pourrait comprendre plusieurs référentiels pour un certain nombre de projets. La manière Git est de les diviser et d'avoir des dépôts Git séparés pour chaque projet. Les raisons sont les suivantes:

• Git est plus rapide pour les petits dépôts.
• En raison de sa conception, chaque opération affecte l' ensemble du référentiel . Il est inefficace d'effectuer des opérations Git sur les projets nécessaires si vous ne travaillez que sur l'un d'entre eux.

La documentation, comme toujours, est indispensable. Alors que les gens savent lire le code, personne ne veut plus interpréter le code que nécessaire. Utiliser le README de haut niveau pour décrire le projet et la structure du référentiel Git sera toujours une bonne chose pour ceux qui sont impliqués (ou qui cherchent à s'impliquer) dans le projet.

La majorité du projet sur GitHub est conforme aux conventions. Utilisez-les comme exemples pour structurer vos futurs projets.