코드 공유를위한 모범 사례 / 나쁜 사례? [닫은]

내가 Github을 더 많이 탐색 할수록 더 좋아한다. 코딩이 점점 사회화되는 방식을 정말 좋아합니다.

프로그래머가 서로 코드를 공유하지 말아야 할 나쁜 관행 이 있는지 궁금 합니다. 그리고 나쁜 사례를 명명 할 때 코드 공유를위한 모범 사례는 무엇 입니까?

예를 들면 다음과 같습니다.

단일 리포지토리에 'MiscProjects' 라는 여러 스크립트 / 프로젝트가있는 것은 좋지 않습니까? 이 레포는 이름에서 알 수 있듯이 기타 작은 스크립트 및 프로젝트 모음입니다. 이것은 프로그래머가 로컬 스토리지에서 프로젝트를 구성하는 방법과 유사하지만 코드 공유에 최적이 아닐 수 있습니까?

README / 문서가 잘 작성 되었다면 더 좋을까요? 또는 문서화가 잘되어 있다면 어떤 일이 있습니까?

어떤이 있지만 '나쁜 관행' 역시 다른 버전 관리 시스템과 돌 세트, 이없는 규칙 .

Git 리포지는 가능한 작아야합니다. CVS / SVN 모듈에서 오는 경우 여러 프로젝트에 대해 여러 저장소를 구성 할 수있는 구조화 된 단일 저장소를 갖는 것이 일반적입니다. 힘내 방법은 각 프로젝트에 대해 별도의 망할 놈의 repos를 다음을 분할하는 것입니다. 이유는 다음과 같습니다.

• 작은 repos에서는 Git이 더 빠릅니다 .
• 디자인으로 인해 각 작업은 전체 리포지토리에 영향을줍니다 . 필요한 프로젝트 중 하나에서만 작업하는 경우 필요한 프로젝트에 대해 Git 작업을 수행하는 것은 비효율적입니다.

항상 그렇듯이 문서는 필수입니다. 사람들은 코드를 읽는 데 능숙하지만 아무도 코드를 해석 하기 를 원하는 사람은 없습니다 . 프로젝트와 Git 리포지토리의 구조를 설명하기 위해 최상위 README를 사용하는 것은 프로젝트에 참여하는 사람들에게 항상 좋은 일이 될 것입니다.

GitHub 프로젝트의 대부분은 컨벤션을 준수합니다. 향후 프로젝트를 구성하는 방법에 대한 예제로 사용하십시오.