Praktik Terbaik / Buruk untuk berbagi kode? [Tutup]

Semakin saya menjelajahi Github , semakin saya menyukainya. Saya sangat menikmati bagaimana pengkodean menjadi lebih sosial.

Saya ingin tahu apakah ada praktik buruk yang harus dihindari oleh programmer dalam membagikan kode mereka satu sama lain. Dan dalam menyebutkan praktik buruk, praktik apa yang terbaik untuk berbagi kode ?

Sebagai contoh:

Apakah praktik yang buruk bagi satu repo memiliki banyak skrip / proyek bernama 'MiscProjects' ? Di mana repo ini, seperti namanya, adalah kumpulan skrip dan proyek kecil lain-lain. Ini mungkin menyerupai bagaimana seorang programmer mengatur proyek pada penyimpanan lokalnya, tetapi mungkin tidak optimal untuk berbagi kode?

Mungkin jika README / dokumentasi yang baik dilakukan, akan lebih baik? Atau selama itu terdokumentasi dengan baik, apa saja?

Meskipun tidak ada 'praktik buruk' yang diterapkan, demikian pula dengan sistem kontrol versi lainnya, ada konvensi .

Repo Git Anda harus sekecil mungkin. Jika Anda berasal dari modul CVS / SVN, biasanya memiliki repositori tunggal terstruktur yang dapat menyusun beberapa repositori untuk sejumlah proyek. Cara Git adalah untuk membagi ini dan memiliki repositori Git yang terpisah untuk setiap proyek. Alasannya adalah:

• Git lebih cepat untuk repo yang lebih kecil.
• Karena desainnya, setiap operasi mempengaruhi seluruh repo . Tidak efisien untuk melakukan operasi Git atas proyek-proyek yang diperlukan jika Anda hanya mengerjakan salah satunya.

Dokumentasi, seperti biasa, adalah suatu keharusan. Sementara orang mahir membaca kode, tidak ada yang mau menafsirkan kode lebih dari yang seharusnya. Menggunakan README tingkat atas untuk menggambarkan proyek dan struktur repo Git akan selalu menjadi hal yang baik bagi mereka yang terlibat (atau ingin terlibat) dalam proyek.

Mayoritas proyek di GitHub sesuai dengan konvensi. Gunakan mereka sebagai contoh untuk bagaimana menyusun proyek masa depan Anda.