rule.md

규칙

Stuckyi-TechCamp 저장소의 작성 규칙에 대한 내용입니다.

주제 선정

주제 선정은 각 주차 주제 선정에 이슈에 발표일 전에 이슈를 남긴다.
폴더만 따로 깃허브에 올라가지 않으므로 파일 폴더는 각 주차의 처음 커밋하는 사람이 올리면 된다.

파일 구조

1. 모든 파일은 ./docs 폴더 하위에 작성한다.
2. N주차 컨텐츠의 경우 N-week 폴더를 만들어서 컨텐츠를 넣는다.

└── docs
    ├── rule.md
    ├── 1-week
    ├── 2-week
    └── ....

3. 예제 파일의 있는 경우에는 주제명-example 형식으로 폴더를 생성하여 그 폴더 안에 넣는다.

└── docs
    ├── rule.md
    ├── 1-week
    │    └── topic-example
    ├── 2-week
    └── ....

파일명

파일명은 한글 발음은 사용하지않고 영어로 사용한다. 띄어쓰기의 경우 _(underline)을 사용한다.

파일의 시작은 # 제목 (영문명&파일명) 영문명은 파일명과 동일하게 한다.
파일 제목을 쓰고 뒤에는 작성자 : 이름(깃허브주소링크)로 표시한다.
그리고 난뒤에는 자유 양식으로 작성하면 된다.

• 예시 : topic.md

  # 제목 (topic)
  
  #### 작성자 : [이병민](https://github.com/ByeongminLee)
  
  -=- 내용 영역 -=-