Best / Bad practice per la condivisione del codice? [chiuso]

Più esploro Github , più mi piace. Mi piace molto come il codice sta diventando più social.

Sono curioso di sapere se ci sono cattive pratiche che i programmatori dovrebbero evitare nel condividere il loro codice. E nel nominare le cattive pratiche, quali sono le migliori pratiche per la condivisione del codice ?

Per esempio:

È una cattiva pratica per un singolo repository avere più script / progetti denominati "MiscProjects" ? Dove questo repository, come suggerisce il nome, è una raccolta di piccoli script e progetti vari. Questo potrebbe assomigliare al modo in cui un programmatore organizza i progetti nella sua memoria locale, ma forse non è ottimale per la condivisione del codice?

Forse se viene fatto un buon README / documentazione, sarebbe meglio? O finché è ben documentato, tutto va bene?

Sebbene non vi siano "cattive pratiche" messe in pratica , allo stesso modo di altri sistemi di controllo delle versioni, esistono convenzioni .

Il tuo repository Git dovrebbe essere il più piccolo possibile. Se provenite dal modulo CVS / SVN, era comune disporre di un singolo repository strutturato che potesse comporre più repository per un numero di progetti. Il modo Git è dividerli e avere repository Git separati per ogni progetto. I motivi sono:

• Git è più veloce per piccoli repository.
• Grazie al suo design, ogni operazione influenza l' intero repository . È inefficiente eseguire operazioni Git su progetti necessari se si sta lavorando solo su uno di essi.

La documentazione, come sempre, è un must. Mentre le persone sono abili nella lettura del codice, nessuno vuole interpretare il codice più di quanto sia necessario. Usare il README di alto livello per descrivere il progetto e la struttura del repository Git sarà sempre una buona cosa per le persone coinvolte (o che vogliono essere coinvolte) nel progetto.

La maggior parte del progetto su GitHub è conforme alle convenzioni. Usali come esempi per come strutturare i tuoi progetti futuri.