Skip to content

Commit

Permalink
docs: add guide for husky
Browse files Browse the repository at this point in the history
  • Loading branch information
wonkyDD committed Feb 7, 2024
1 parent dd5792e commit 1848120
Showing 1 changed file with 47 additions and 4 deletions.
51 changes: 47 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,50 @@
# HYU-PS-STUDY

## Notice

`husky` 를 사용해 현재 커밋 메시지를 강제하고 있습니다.

다음과 같은 의존성 설치가 필요합니다.

### 1. 패키지 매니저 설치

```shell
# https://pnpm.io/installation

# npm이 깔려있다면
npm install -g pnpm

# homebrew를 원한다면
brew install pnpm
```

2. 프로젝트 의존성 설치

```shell
pnpm install
```

이게 전부입니다.
자동으로 모든 셋업을 완료합니다.

<br>

커밋 메세지는 정규식
> `^\[week-\d+-[a-zA-Z0-9-]+\] (\d+, )*\d+$`
으로 검증하며 자세한 내용은
[husky](/.husky/commit-msg) 에서 확인하실 수 있습니다.

만약 커밋 메세지 강제를 피하고 싶으시다면
`--no-verify` 옵션을 사용하시면 됩니다.


**예시**

```shell
git commit -m'커밋 메세지' --no-verify
```


## 스타디 방식

Expand Down Expand Up @@ -50,7 +95,5 @@ git push -u origin [깃허브 아이디]

### 3. 코드 리뷰

매주 한명의 pr만 리뷰해주면 됩니다.
리뷰어는 리뷰를 한뒤 해당 pr을 merge해주시면 됩니다.

이미 리뷰받은 pr은 리뷰할 수 없습니다.
최소 한명 이상의 pr을 리뷰해주시면 됩니다.
Merge는 매주 스타디가 끝났을때 해주시면 됩니다.

0 comments on commit 1848120

Please sign in to comment.