Skip to content

Commit 621dabc

Browse files
committed
docs: add helpful docs to .github
1 parent 2b71354 commit 621dabc

File tree

3 files changed

+102
-0
lines changed

3 files changed

+102
-0
lines changed

.github/CONTRIBUTING.md

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# 기여하기
2+
3+
함수랑 산악회의 `쏙쏙쑥쑥` 스터디에 관심을 갖고 찾아주셔서 감사합니다! 🙇‍♂️
4+
5+
## Issues
6+
7+
다음과 같은 내용들은 Issue를 활용해서 자유롭게 제안해주세요!
8+
9+
- [docs](https://functional-coding-nutshell-docs.vercel.app/) 개선
10+
- 문제 개선 및 버그 제보
11+
- 스터디 진행 방식 개선 및 건의사항
12+
13+
## Pull requests
14+
15+
### PR 만들기
16+
17+
### 프로젝트 세팅하기
18+
19+
다음 단계는 `쏙쏙쑥쑥`에 기여하기 위해 프로젝트를 세팅하는 단계입니다.
20+
21+
1. Fork를 합니다.
22+
23+
2. Fork된 repo를 로컬로 clone 받습니다.
24+
25+
```bash
26+
git clone https://github.com/<your_github_username>/functional-coding-nutshell.git # 만약 이름을 바꿨다면, 변경한 이름으로 클론 받으셔야 합니다.
27+
28+
cd functional-coding-nutshell
29+
```
30+
31+
이 프로젝트는 yarn 3 버전을 활용해서 구성한 monorepo 구성입니다.
32+
typescript 버전 세팅을 workspace의 버전을 사용할 수 있도록 세팅해주세요.
33+
34+
만약, yarn이 없으신 경우 설치해주시길 바랍니다.
35+
[yarn 설치하는 방법](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable)
36+
37+
3. nvm
38+
39+
프로젝트에서 사용하는 Node 버전은 `16.17.1` 입니다.
40+
41+
```bash
42+
# in root project path (if you don't have 16.17.1)
43+
nvm install
44+
45+
nvm use
46+
```
47+
48+
`nvm`을 사용해야 할 이유는 없습니다. node 버전을 `16.17.1`로 맞춰서 프로젝트 환경 세팅을 마무리해주시면 됩니다.
49+
50+
### docs 페이지 실행하기 (개발환경)
51+
52+
```bash
53+
# in root project path
54+
yarn docs dev
55+
```
56+
57+
모노레포 환경 구성이기 때문에 프로젝트의 루트 경로에서 해당 명령어를 실행해주시면 됩니다.
58+
59+
### 실습 문제 테스트 실행하기 (예제)
60+
61+
```bash
62+
# in root project path
63+
yarn example test
64+
```
65+
66+
만약, Jest Runner를 사용하시는 분이라면 .vscode/settings.json 파일이 올라가있기 때문에, 바로 실행시켜보실 수 있습니다.
67+
68+
### 예제 및 실습 제출하기
69+
70+
제출하는 방법은 다음과 같습니다.
71+
72+
`<문제번호>/__submit__`
73+
74+
의 경로에 다음과 같이 구성해주시면 됩니다.
75+
76+
```
77+
- <문제번호>/__submit__
78+
ᄂ <your_github_username>.ts
79+
ᄂ <your_github_username>.(spec|test).ts
80+
```

.github/SUPPORT.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Welcome to 쏙쏙쑥쑥!
2+
3+
쏙쏙쑥쑥 스터디는 github를 통해 실습 문제를 만들고 풀고 있어요,
4+
또한 monorepo를 통해 docs를 작성하고 배포하고 있어요!
5+
6+
저희와 연결할 수 있는 채널들이 몇 가지 있습니다.
7+
8+
## Slack
9+
10+
Slack은 초대된 쏙쏙쑥쑥 스터디원 분들만 입장이 가능해요.
11+
[슬랙 입장하기](https://function-and-mountain.slack.com)
12+
13+
## Documentation
14+
15+
- [쏙쏙쑥쑥 Docs](https://functional-coding-nutshell-docs.vercel.app/)
16+
- [노션](https://minsooweb.notion.site/a6f94677860c462399db96f34e121c70?pvs=4)
17+
18+
## Contact Us
19+
20+
- [카카오톡 오픈채팅](https://open.kakao.com/o/sTjHAUsf)
21+
- [스터디 개선 및 제안하기](https://github.com/function-and-mountain/functional-coding-nutshell/issues/new)

.nvmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
16.17.1

0 commit comments

Comments
 (0)