Skip to content

Commit e00c448

Browse files
authored
docs: Add Yarn 4 package manager information to CONTRIBUTING guides (toss#1523)
* docs: add Yarn 4 package manager information to CONTRIBUTING guides * docs: fix spacing
1 parent b6ffb6d commit e00c448

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

.github/CONTRIBUTING-ko_kr.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@
44

55
> es-toolkit에 기여할 때, [행동 강령(Code of conduct)](./CODE_OF_CONDUCT.md)을 준수해 주세요. 허용되는 행동과 허용되지 않는 행동을 준수해 주세요.
66
7+
## 패키지 매니저
8+
9+
이 프로젝트는 **Yarn 4**를 패키지 매니저로 사용해요. `yarn install`을 실행하면 Corepack을 통해 올바른 버전이 자동으로 설치돼요.
10+
11+
시작하는 방법:
12+
13+
1. Node.js가 설치되어 있는지 확인하세요 (필요한 버전은 `.nvmrc` 파일을 참고하세요)
14+
2. Corepack을 활성화하세요: `corepack enable`
15+
3. 의존성을 설치하세요: `yarn install`
16+
717
## 1. 설계 원칙
818

919
es-toolkit 프로젝트는 성능, 구현의 단순함, 그리고 꼼꼼한 문서화가 중요해요. 다양한 기능과 옵션을 지원하기보다, 성능이 뛰어나고 안정적으로 작동하는 핵심 유틸리티들만 제공하려고 해요.

.github/CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ We welcome contribution from everyone in the community. All communications in th
44

55
> Every contributor to es-toolkit should adhere to our Code of Conduct. Please read the [full text](./CODE_OF_CONDUCT.md) to understand what actions will and will not be tolerated.
66
7+
## Package Manager
8+
9+
This project uses **Yarn 4** as its package manager. The correct version is automatically installed via Corepack when you run `yarn install`.
10+
11+
To get started:
12+
13+
1. Make sure you have Node.js installed (see `.nvmrc` for the required version)
14+
2. Enable Corepack: `corepack enable`
15+
3. Install dependencies: `yarn install`
16+
717
## 1. Our Design Principles
818

919
Note that we value performance, simplicity of implementation, and detailed documentations. We do not aim for supporting a variety of features and options. Our goal is to provide a small set of performant and well-functioning utilities.

0 commit comments

Comments
 (0)