Лучшие / плохие практики для совместного использования кода? [закрыто]

Чем больше я изучаю Github , тем больше он мне нравится. Мне действительно нравится, как кодирование становится все более социальным.

Мне любопытно, есть ли какие-то плохие практики , которых программисты должны избегать, делясь своим кодом друг с другом. И как назвать плохие практики, каковы лучшие практики для совместного использования кода ?

Например:

Является ли плохой практикой для одного репо иметь несколько сценариев / проектов с именем «MiscProjects» ? Где это репо, как следует из названия, представляет собой набор различных небольших сценариев и проектов. Это может напоминать, как программист организует проекты в своем локальном хранилище, но, возможно, это не оптимально для совместного использования кода?

Может быть, если сделать хороший README / документацию, будет лучше? Или, если это хорошо задокументировано, что-нибудь идет?

Хотя в камне нет «плохих практик», как и в случае с другими системами контроля версий, существуют соглашения .

Ваш репозиторий Git должен быть как можно меньше. Если вы работаете с модулем CVS / SVN, обычно было иметь структурированный единый репозиторий, который мог бы состоять из нескольких репозиториев для ряда проектов. Способ Git состоит в том, чтобы разделить их и создать отдельные репозитории Git для каждого проекта. Причины:

• Git быстрее для небольших репо.
• Благодаря своей конструкции каждая операция влияет на весь репо . Неэффективно выполнять операции Git над необходимыми проектами, если вы работаете только над одним из них.

Документация, как всегда, обязательна. Хотя люди умеют читать код, никто не хочет интерпретировать код так, как ему нужно. Использование README верхнего уровня для описания проекта и структуры репозитория Git всегда будет полезным для тех, кто вовлечен (или хочет участвовать) в проект.

Большинство проектов на GitHub соответствуют конвенциям. Используйте их как примеры того, как структурировать ваши будущие проекты.