Best / Bad Practices für die gemeinsame Nutzung von Code? [geschlossen]

Je mehr ich Github erforsche , desto mehr gefällt es mir. Ich genieße es wirklich, wie das Codieren sozialer wird.

Ich bin gespannt, ob es schlechte Praktiken gibt , die Programmierer vermeiden sollten , wenn sie ihren Code miteinander teilen. Und was sind die besten Methoden für die gemeinsame Nutzung von Code , wenn Sie schlechte Praktiken benennen ?

Beispielsweise:

Ist es eine schlechte Praxis für ein einzelnes Repo, mehrere Skripte / Projekte mit dem Namen "MiscProjects" zu haben ? Wo dieses Repo, wie der Name schon sagt, eine Sammlung verschiedener kleiner Skripte und Projekte ist. Dies ähnelt möglicherweise der Organisation von Projekten durch einen Programmierer in seinem lokalen Speicher, ist jedoch möglicherweise nicht optimal für die gemeinsame Nutzung von Code.

Vielleicht wäre es besser, wenn eine gute README / Dokumentation fertig ist? Oder solange es gut dokumentiert ist, geht alles?

Während es keine "schlechten Praktiken" gibt, die in Stein gemeißelt sind, wie auch bei anderen Versionskontrollsystemen, gibt es Konventionen .

Dein Git-Repo sollte so klein wie möglich sein. Wenn Sie aus dem CVS / SVN-Modul stammen, war es üblich, ein strukturiertes einzelnes Repository zu haben, das aus mehreren Repositorys für eine Reihe von Projekten bestehen kann. Die Git-Methode besteht darin, diese aufzuteilen und für jedes Projekt separate Git-Repos zu erstellen. Gründe sind:

• Git ist schneller für kleinere Repos.
• Aufgrund seines Designs wirkt sich jeder Vorgang auf das gesamte Repo aus . Es ist ineffizient, Git-Operationen für erforderliche Projekte auszuführen, wenn Sie nur an einem von ihnen arbeiten.

Dokumentation ist wie immer ein Muss. Während die Leute geschickt darin sind, Code zu lesen, möchte niemand Code mehr interpretieren, als er braucht. Die Verwendung der README-Datei der obersten Ebene zur Beschreibung des Projekts und der Struktur des Git-Repos ist immer eine gute Sache für diejenigen, die an dem Projekt beteiligt sind (oder sich daran beteiligen möchten).

Der Großteil des Projekts auf GitHub entspricht den Konventionen. Verwenden Sie sie als Beispiele für die Strukturierung Ihrer zukünftigen Projekte.