프로젝트 구성 방법 - dev-graft/syuck-syuck-docs GitHub Wiki
1. 리포지토리 타입
프로젝트를 진행하면서 생성되는 자료의 타입 입니다. backend,web,mobile 등은 platform으로 문서에서 표기합니다.
| 타입 | 설명 | 규칙 |
|---|---|---|
| backend | 프로젝트의 backend 자료를 관리합니다. | 종류가 두 가지 이상 일 경우 (spring, node...)로 작성바랍니다. |
| web | 프로젝트의 web 자료를 관리합니다. | 종류가 두 가지 이상 일 경우 (react, angular...)로 작성바랍니다. |
| mobile | 프로젝트의 mobile 자료를 관리합니다. | 종류가 두 가지 이상 일 경우 (android, ios...)로 작성바랍니다. |
| docs | 프로젝트의 Wiki, 이슈 등을 관리합니다. | backend, web 등 단 하나의 프로젝트만 필요해도 필수로 구성해야합니다. |
2. 리포지토리 명명 규칙
리포지토리 이름을 구성하는 방법은 다음과 같습니다.
프로젝트 명 형태: {project-name}-{repository-type}
- project-name: 프로젝트 명 / 영문 소문자와 띄어쓰기는 - 로 대체합니다.
- repository-type: server, web, ios, android, docs 등
example: syuck-syuck-docs, syuck-syuck-server
3. 리포지토리 생성 시작하기
리포지토리 타입을 분리하여 프로젝트 진행에 필요한 문서를 별도로 관리할 수 있습니다. 이렇게 분리된 문서는 프로젝트 진행을 정확히 하고, 블로그나 포트폴리오에 반영할 수 있기 때문에 다음 문서들을 꼭 필독해주세요!