Le migliori / cattive pratiche per la condivisione del codice? [chiuso]

Naviga le tue risposte
9

Più esploro Github , più mi piace. Mi piace davvero come la codifica stia diventando più sociale.

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

Ad 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 può assomigliare al modo in cui un programmatore organizza i progetti sulla sua memoria locale, ma forse non è ottimale per la condivisione del codice?

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

    
posta spong 19.03.2011 - 06:34
fonte

1 risposta

9

Sebbene non ci siano "cattive pratiche" impostate nella pietra, allo stesso modo con altri sistemi di controllo delle versioni, ci sono convenzioni .

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

  • Git è più veloce per i repository più piccoli.
  • A causa della sua progettazione, ogni operazione influisce sul intero repository . È inefficiente eseguire le operazioni Git sui progetti necessari se stai lavorando solo su uno di essi.

La documentazione, come sempre, è un must. Mentre le persone sono abili a leggere il codice, nessuno vuole interpretare il codice più del necessario. Utilizzare il README di primo livello per descrivere il progetto e la struttura del repo Git sarà sempre una buona cosa per le persone coinvolte (o che vorranno essere coinvolte) nel progetto.

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

    
risposta data 19.03.2011 - 06:53
fonte

Leggi altre domande sui tag

Come proteggersi dall'essere denunciati da brevetti? Valutazione del set di dati con una formula di stringa in php