Skip to content

Commit 9022de9

Browse files
committed
Update docs
readme.md contributing.md code_of_conduct.md
1 parent f75b815 commit 9022de9

File tree

4 files changed

+92
-5
lines changed

4 files changed

+92
-5
lines changed

โ€Žcode_of_conduct.md

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# ๊ธฐ์—ฌ์ž ํ–‰๋™ ๊ฐ•๋ น ๊ทœ์•ฝ
2+
3+
## ์„œ์•ฝ
4+
5+
๊ฐœ๋ฐฉ์ ์ด๊ณ  ์นœ๊ทผํ•œ ํ™˜๊ฒฝ ์กฐ์„ฑ์„ ์œ„ํ•ด, ๊ธฐ์—ฌ์ž์™€ ์œ ์ง€์ž๋Š” ํ”„๋กœ์ ํŠธ์™€ ์ปค๋ฎค๋‹ˆํ‹ฐ์—์„œ
6+
์—ฐ๋ น, ์‹ ์ฒด ํฌ๊ธฐ, ์žฅ์• , ๋ฏผ์กฑ์„ฑ, ์„ฑ ์ •์ฒด์„ฑ๊ณผ ํ‘œํ˜„, ๊ฒฝ๋ ฅ, ๊ตญ์ , ์™ธ๋ชจ, ์ธ์ข…, ์ข…๊ต
7+
๋˜๋Š” ์„ฑ์  ์ •์ฒด์„ฑ๊ณผ ์ง€ํ–ฅ์— ๊ด€๊ณ„์—†์ด ๋ชจ๋‘์—๊ฒŒ ์ฐจ๋ณ„์—†์ด ์ฐธ์—ฌํ•  ๊ฒƒ์„ ์„œ์•ฝํ•ฉ๋‹ˆ๋‹ค.
8+
9+
## ํ‘œ์ค€
10+
11+
๊ธ์ •์ ์ธ ํ™˜๊ฒฝ์„ ์กฐ์„ฑํ•˜๊ธฐ ์œ„ํ•ด ๊ธฐ์—ฌ์ž๊ฐ€ ํ•ด์•ผ ํ•  ํ–‰๋™์€ ๋‹ค์Œ๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค:
12+
13+
- ์†Œ์™ธํ•˜์ง€ ์•Š๊ณ  ๋ฐฐ๋ คํ•˜๋Š” ์–ธ์–ด ์‚ฌ์šฉ
14+
- ์„œ๋กœ ๋‹ค๋ฅธ ๊ฒฝํ—˜๊ณผ ๊ด€์  ์กด์ค‘
15+
- ์—ด๋ฆฐ ๋งˆ์Œ์œผ๋กœ ๊ฑด์„ค์ ์ธ ๋น„ํŒ์„ ์ˆ˜์šฉ
16+
- ์ปค๋ฎค๋‹ˆํ‹ฐ์— ๊ฐ€์žฅ ์ตœ์„ ์ด ๋ฌด์—‡์ธ์ง€์— ์ฃผ๋ ฅ
17+
- ๋‹ค๋ฅธ ์ปค๋ฎค๋‹ˆํ‹ฐ ๊ตฌ์„ฑ์›๋“ค์— ๋Œ€ํ•œ ๊ณต๊ฐ ํ‘œํ˜„
18+
19+
ํ•˜์ง€๋ง์•„์•ผ ํ•  ํ–‰๋™์€ ๋‹ค์Œ๊ณผ ๊ฐ™์Šต๋‹ˆ๋‹ค:
20+
21+
- ์„ฑ์ ์ธ ์–ธ์–ด์™€ ์ด๋ฏธ์ง€ ์‚ฌ์šฉ, ์›์น˜์•Š๋Š” ์„ฑ์  ๊ด€์‹ฌ์ด๋‚˜ ์ ‘๊ทผ
22+
- ์†Œ๋ชจ์ ์ธ ๋…ผ์Ÿ, ๋ชจ์š•์ ์ด๊ฑฐ๋‚˜ ๋น„ํ•˜ํ•˜๋Š” ๋Œ“๊ธ€๊ณผ ๊ฐœ์ธ์  ๋˜๋Š” ์ •์น˜์ ์ธ ๊ณต๊ฒฉ
23+
- ๊ณต๊ฐœ์ ์ด๊ฑฐ๋‚˜ ๊ฐœ์ธ์ ์ธ ๊ดด๋กญํž˜
24+
- ๋™์˜์—†๋Š” ์ง‘์ฃผ์†Œ ๋˜๋Š” ์ „์ž์ฃผ์†Œ ๋“ฑ์˜ ๊ฐœ์ธ ์ •๋ณด์˜ ๊ณต๊ฐœ
25+
- ๋ถ€์ ์ ˆํ•œ ๊ฒƒ์œผ๋กœ ๊ฐ„์ฃผ๋  ์ˆ˜ ์žˆ๋Š” ๋‹ค๋ฅธ ํ–‰์œ„
26+
27+
## ์ฑ…์ž„
28+
29+
ํ”„๋กœ์ ํŠธ ์œ ์ง€์ž๋Š” ํ—ˆ์šฉ๋˜๋Š” ํ–‰๋™์˜ ๊ธฐ์ค€์„ ๋ช…ํ™•ํžˆ ํ•ด์•ผํ•  ์ฑ…์ž„์ด ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ,
30+
ํ•˜์ง€๋ง์•„์•ผ ํ•  ํ–‰๋™์— ๋Œ€ํ•ด ์ ๋‹นํ•˜๊ณ  ๊ณต์ •ํ•œ ์‹œ์ • ์กฐ์น˜๋ฅผ ์ทจํ•  ๊ฒƒ ์ž…๋‹ˆ๋‹ค.
31+
32+
ํ”„๋กœ์ ํŠธ ์œ ์ง€์ž๋Š” ์ด ํ–‰๋™ ๊ฐ•๋ น์„ ๋”ฐ๋ฅด์ง€ ์•Š์€ ๋Œ“๊ธ€, ์ปค๋ฐ‹, ์ฝ”๋“œ, ์œ„ํ‚ค ํŽธ์ง‘,
33+
์ด์Šˆ์™€ ๊ทธ ์™ธ ๋‹ค๋ฅธ ๊ธฐ์—ฌ๋ฅผ ์‚ญ์ œ, ์ˆ˜์ • ๋˜๋Š” ๊ฑฐ๋ถ€ํ•  ๊ถŒ๋ฆฌ์™€ ์ฑ…์ž„์ด ์žˆ์Šต๋‹ˆ๋‹ค. ๋˜ํ•œ,
34+
๋ถ€์ ๋‹นํ•˜๊ฑฐ๋‚˜ ํ—˜์•…ํ•˜๊ฑฐ๋‚˜ ๊ณต๊ฒฉ์ ์ด๊ฑฐ๋‚˜ ํ•ด๋กญ๋‹ค๊ณ  ์ƒ๊ฐํ•˜๋Š” ๋‹ค๋ฅธ ํ–‰๋™์„ ํ•œ ๊ธฐ์—ฌ์ž๋ฅผ
35+
์ผ์‹œ์  ๋˜๋Š” ์˜๊ตฌ์ ์œผ๋กœ ํ‡ด์žฅ์‹œํ‚ฌ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
36+
37+
## ๋ฒ”์œ„
38+
39+
์ด ํ–‰๋™ ๊ฐ•๋ น์€ ํ”„๋กœ์ ํŠธ ์˜์—ญ์— ์ ์šฉ๋˜๋ฉฐ, ํ”„๋กœ์ ํŠธ ๋˜๋Š” ์ปค๋ฎค๋‹ˆํ‹ฐ๋ฅผ ๋Œ€ํ‘œํ•  ๊ฒฝ์šฐ
40+
๊ณต๊ฐœ ์˜์—ญ์—๋„ ์ ์šฉ๋ฉ๋‹ˆ๋‹ค. ํ”„๋กœ์ ํŠธ ๋˜๋Š” ์ปค๋ฎค๋‹ˆํ‹ฐ ๋Œ€ํ‘œ์˜ ์˜ˆ๋กœ๋Š” ๊ณต์‹ ํ”„๋กœ์ ํŠธ
41+
์ด๋ฉ”์ผ ์ฃผ์†Œ, ๊ณต์‹ ์†Œ์…œ ๋ฏธ๋””์–ด ๊ณ„์ •์‚ฌ์šฉ ๋˜๋Š” ์˜จ/์˜คํ”„๋ผ์ธ ์ด๋ฒคํŠธ์—์„œ ์ž„๋ช…๋œ
42+
๋Œ€ํ‘œ์ž์˜ ํ™œ๋™์ด ์žˆ์Šต๋‹ˆ๋‹ค. ํ”„๋กœ์ ํŠธ์˜ ๋Œ€ํ‘œ๋Š” ํ”„๋กœ์ ํŠธ ์œ ์ง€์ž์— ์˜ํ•ด ๋” ์ •์˜๋˜๊ณ 
43+
๋ช…ํ™•ํžˆ ๋  ๊ฒƒ ์ž…๋‹ˆ๋‹ค.
44+
45+
## ๊ฐ•์ œ
46+
47+
๋ชจ์š•์ ์ธ, ๊ดด๋กญํž˜ ๋˜๋Š” ๊ธฐํƒ€ ํ•˜์ง€๋ง์•„์•ผ ํ•  ํ–‰๋™์„ ๋ฐœ๊ฒฌํ•˜๋ฉด <mailto:[email protected]> ์„
48+
ํ†ตํ•ด ํ”„๋กœ์ ํŠธ ํŒ€์— ๋ณด๊ณ  ํ•ด ์ฃผ์„ธ์š”. ๋ชจ๋“  ๋ถˆ๋งŒ์‚ฌํ•ญ์€ ๊ฒ€ํ† ํ•˜๊ณ  ์กฐ์‚ฌํ•œ ๋’ค ์ƒํ™ฉ์—
49+
๋”ฐ๋ผ ํ•„์š”ํ•˜๊ณ  ์ ์ ˆํ•˜๋‹ค๊ณ  ์ƒ๊ฐ๋˜๋Š” ์‘๋‹ต์„ ํ•  ๊ฒƒ ์ž…๋‹ˆ๋‹ค. ํ”„๋กœ์ ํŠธ ํŒ€์€ ์‚ฌ๊ฑด์˜
50+
๋ณด๊ณ ์ž์™€ ๊ด€๋ จํ•œ ๋น„๋ฐ€์„ ์œ ์ง€ํ•  ์˜๋ฌด๊ฐ€ ์žˆ์Šต๋‹ˆ๋‹ค. ๊ตฌ์ฒด์ ์ธ ์‹œํ–‰ ์ •์ฑ…์˜ ์ž์„ธํ•œ
51+
์‚ฌํ•ญ์€ ๋ณ„๋„๋กœ ๊ฒŒ์‹œํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
52+
53+
ํ–‰๋™ ๊ฐ•๋ น์„ ๋”ฐ๋ฅด์ง€ ์•Š๊ฑฐ๋‚˜ ๊ฐ•์ œํ•˜์ง€ ์•Š์€ ํ”„๋กœ์ ํŠธ ์œ ์ง€์ž๋Š” ํ”„๋กœ์ ํŠธ ๋ฆฌ๋”์˜ ๋‹ค๋ฅธ
54+
๊ตฌ์„ฑ์›์˜ ๊ฒฐ์ •์— ๋”ฐ๋ผ ์ผ์‹œ์  ๋˜๋Š” ์˜๊ตฌ์ ์ธ ์ œ์žฌ๋ฅผ ๋ฐ›์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.
55+
56+
## ์ฐธ๊ณ 
57+
58+
์ด ํ–‰๋™ ๊ฐ•๋ น์€ [๊ธฐ์—ฌ์ž ๊ทœ์•ฝ][homepage] ์˜ 1.4 ๋ฒ„์ „์„ ๋ณ€ํ˜•ํ•˜์˜€์Šต๋‹ˆ๋‹ค. ๊ทธ ๋‚ด์šฉ์€
59+
[http://contributor-covenant.org/version/1/4/ko][version] ์—์„œ ํ™•์ธํ•  ์ˆ˜
60+
์žˆ์Šต๋‹ˆ๋‹ค.
61+
62+
[homepage]: http://contributor-covenant.org
63+
64+
[version]: http://contributor-covenant.org/version/1/4/ko/

โ€Žcontributing.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# ๊ธฐ์—ฌํ•˜๊ธฐ
2+
3+
์ด ํ”„๋กœ์ ํŠธ๋Š” [๊ธฐ์—ฌ์ž ๊ทœ์•ฝ](./code_of_conduct.md)๋ฅผ ์ค€์ˆ˜ํ•ฉ๋‹ˆ๋‹ค.
4+
5+
## Issue ์ œ์ถœ
6+
7+
React์˜ ๊ต์žฌ์™€ ๊ด€๋ จ๋œ ์ด์Šˆ๋ผ๋ฉด ๋ญ๋“ ์ง€ ํ™˜์˜ํ•ฉ๋‹ˆ๋‹ค. ํžŒํŠธ๋ฅผ ๋“œ๋ฆฌ๋ฉด ๋‹ค์Œ๊ณผ ๊ฐ™์€ ๊ฒƒ์ด ๋˜๊ฒ ๋„ค์š”.
8+
9+
- React์™€ ๊ด€๋ จ๋œ ์ข‹์€ ์ž๋ฃŒ์˜ ์ถ”๊ฐ€(์ž๊ธฐ๊ฐ€ ์“ด ๊ฒƒ๋„ ์ข‹์Šต๋‹ˆ๋‹ค.)
10+
- ์˜ค๋ž˜๋˜๊ฑฐ๋‚˜ ์ž˜๋ชป๋œ ์ž๋ฃŒ์˜ ์‚ญ์ œ
11+
- ๋ฒˆ์—ญ ์š”์ฒญ
12+
13+
## Pull Request
14+
15+
๋ณธ ๋ฆฌํฌ์ง€ํ„ฐ๋ฆฌ๋Š” ๊ธ€๋“ค์˜ ํฌ๋งท์„ ์œ ์ง€ํ•˜๊ธฐ์œ„ํ•ด ๋ฆฐํ„ฐ๊ฐ€ ๋‚ด์žฅ๋˜์–ด์žˆ์Šต๋‹ˆ๋‹ค. ๊ธ€์„ ์ž‘์„ฑ ํŽธ์ง‘ํ•˜์‹ค ๊ฒฝ์šฐ, `npm test`๋กœ ๋ฆฐํŠธ ํ…Œ์ŠคํŠธ๊ฐ€ ํ†ต๊ณผํ•˜๋Š”์ง€๋ฅผ ํ™•์ธํ•ด์ฃผ์„ธ์š”. ๋˜ํ•œ, `npm run fix`๋ฅผ ์‚ฌ์šฉํ•˜๋ฉด ์ž๋™์ ์œผ๋กœ ๋Œ€๋ถ€๋ถ„์˜ ๋ฆฐํŠธ ์—๋Ÿฌ๋ฅผ ๊ณ ์ณ์ค๋‹ˆ๋‹ค.
16+
17+
ํ‘ธ์‰ฌ๋œ ์ปค๋ฐ‹์€ TravisCI๋ฅผ ํ†ตํ•ด ๋‹ค์‹œ ํ•œ๋ฒˆ ํ™•์ธ๋˜๋ฏ€๋กœ, ๋นŒ๋“œ ์‹คํŒจ์‹œ ์—๋Ÿฌ๋ฉ”์„ธ์ง€๋ฅผ ํ™•์ธํ•˜์…”์„œ ์ˆ˜์ • ์ปค๋ฐ‹์„ ์ถ”๊ฐ€ํ•ด์ฃผ์„ธ์š”.

โ€Žpackage.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
"remark-preset-lint-recommended": "^2.0.0"
1212
},
1313
"scripts": {
14-
"test": "remark readme.md --frail --quiet"
14+
"test": "remark . -qf",
15+
"fix": "remark . -qfo"
1516
},
1617
"remarkConfig": {
1718
"plugins": ["remark-preset-lint-recommended"]

โ€Žreadme.md

+9-4
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
## React
66

77
- [React์˜ ๊ธฐ๋ณธ, ์ปดํฌ๋„ŒํŠธ๋ฅผ ์•Œ์•„๋ณด์ž](https://medium.com/little-big-programming/react%EC%9D%98-%EA%B8%B0%EB%B3%B8-%EC%BB%B4%ED%8F%AC%EB%84%8C%ED%8A%B8%EB%A5%BC-%EC%95%8C%EC%95%84%EB%B3%B4%EC%9E%90-92c923011818#.uemkhn2ym)
8-
- [[๋ฒˆ์—ญ] ๋ฆฌ์•กํŠธ์— ๋Œ€ํ•ด์„œ ๊ทธ ๋ˆ„๊ตฌ๋„ ์ œ๋Œ€๋กœ ์„ค๋ช…ํ•˜๊ธฐ ์–ด๋ ค์šด ๊ฒƒ โ€“ ์™œ Virtual DOM ์ธ๊ฐ€?](https://velopert.com/3236)
8+
- [\[๋ฒˆ์—ญ\] ๋ฆฌ์•กํŠธ์— ๋Œ€ํ•ด์„œ ๊ทธ ๋ˆ„๊ตฌ๋„ ์ œ๋Œ€๋กœ ์„ค๋ช…ํ•˜๊ธฐ ์–ด๋ ค์šด ๊ฒƒ โ€“ ์™œ Virtual DOM ์ธ๊ฐ€?](https://velopert.com/3236)
99
- [ํ•จ์ˆ˜ํ˜• setState๊ฐ€ ๋ฆฌ์•กํŠธ(React)์˜ ๋ฏธ๋ž˜์ด๋‹ค](https://www.vobour.com/book/view/MPTQLpzxAHxzywcBc)
1010
- [(React Router) v4๋กœ ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ ํ•ด๋ณด์ž!](https://perfectacle.github.io/2017/03/25/react-router-v4/)
1111
- [(React Hot Loader) v3๋กœ ๋งˆ์ด๊ทธ๋ ˆ์ด์…˜ ํ•ด๋ณด์ž!](https://perfectacle.github.io/2017/03/25/react-hot-loader-3/)
1212

1313
## Redux
1414

15-
- [[๋ฒˆ์—ญ] Redux ํ•œ๊ธ€ ๋ฌธ์„œ](http://dobbit.github.io/redux/index.html)
15+
- [\[๋ฒˆ์—ญ\] Redux ํ•œ๊ธ€ ๋ฌธ์„œ](http://dobbit.github.io/redux/index.html)
1616
- [๋ฆฌ๋•์Šค ํŒจํ„ด๊ณผ ์•ˆํ‹ฐ ํŒจํ„ด (Redux Patterns and Anti-Patterns)](https://www.vobour.com/book/view/TGJKKFN2TmyxaGDpN)
1717

1818
## Webpack
@@ -26,9 +26,14 @@
2626

2727
## ๋ฒˆ์—ญ ์š”์ฒญ
2828

29-
๋ฒˆ์—ญ์ด ํ•„์š”ํ•œ ํŽ˜์ด์ง€๋“ค์€ [์ƒˆ ์ด์Šˆ](https://github.com/Rokt33r/learn-react-in-korean/issues/new)๋ฅผ ๋งŒ๋“ค์–ด์„œ ์š”์ฒญํ•ด์ฃผ์„ธ์š”!
29+
๋ฒˆ์—ญ์ด ํ•„์š”ํ•œ ๋ฌธ์„œ๋“ค์€ [์ƒˆ ์ด์Šˆ](https://github.com/Rokt33r/learn-react-in-korean/issues/new)๋ฅผ ๋งŒ๋“ค์–ด์„œ ์š”์ฒญํ•ด์ฃผ์„ธ์š”!
30+
31+
๊ทธ๋ฆฌ๊ณ , ๋ฒˆ์—ญ์„ ๋œ ๋‚ด์šฉ์„ ํ™•์ธํ•ด์ฃผ์‹ค ๋ฆฌ๋ทฐ์–ด๋“ค์„ ๋ชจ์‹ญ๋‹ˆ๋‹ค.
32+
33+
## ๋ฉ”์ธํ…Œ์ด๋„ˆ
34+
35+
[Junyoung Choi (Rokt33r)](https://github.com/rokt33r)
3036

3137
## License
3238

3339
๋ณธ ๋งํฌ ๋ฆฌ์ŠคํŠธ๋Š” [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)ํ•˜์— ์ด์šฉ ๊ฐ€๋Šฅํ•ฉ๋‹ˆ๋‹ค.
34-

0 commit comments

Comments
ย (0)