Skip to content

Commit

Permalink
tidy up docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DaleSeo committed Nov 28, 2024
1 parent 25a0e1f commit 65779af
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 82 deletions.
76 changes: 3 additions & 73 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,75 +1,5 @@
# ๊ธฐ์—ฌ ๋ฐฉ๋ฒ•

## ๋‹ต์•ˆ ์ฝ”๋“œ ์ž‘์„ฑ๋ฒ•

์ฐธ์กฐ ๋งํฌ :
[๊นƒํ—ˆ๋ธŒ(GitHub)์—์„œ์˜ ์˜คํ”ˆ ์†Œ์Šค ํ”„๋กœ์ ํŠธ ๊ธฐ์—ฌ๋ฅผ ์œ„ํ•œ ์ดˆ๋ณด์ž ๊ฐ€์ด๋“œ](https://seongjin.me/how-to-contribute-to-open-source/amp/)

๋จผ์ €, ํ˜„์žฌ ํŽ˜์ด์ง€ ์šฐ์ƒ๋‹จ์— ์žˆ๋Š” ๋ฒ„ํŠผ๋“ค ์ค‘ `Fork` ๋ฒ„ํŠผ ํด๋ฆญํ•˜์—ฌ ๊ฐœ์ธ ์›๊ฒฉ ์ €์žฅ์†Œ๋กœ ๋ณต์‚ฌํ•ด์ค๋‹ˆ๋‹ค.

๊ฐœ์ธ ๋กœ์ปฌ ์ €์žฅ์†Œ๋กœ `Fork`ํ•œ ๊ฐœ์ธ ์›๊ฒฉ ์ €์žฅ์†Œ ์ฝ”๋“œ๋ฅผ ํด๋ก ํ•ฉ๋‹ˆ๋‹ค,

์˜ˆ๋ฅผ ๋“ค์–ด,

```sh
$ git clone https://github.com/Bumsu-Yi/leetcode-study.git
```

ํ‘ธ์‹œ๋ ค๋Š” ๋ฌธ์ œ์˜ ํด๋”์—์„œ ์ž๊ธฐ GitHub ์œ ์ €๋„ค์ž„์œผ๋กœ ํŒŒ์ผ์„ ์ƒ์„ฑํ•ฉ๋‹ˆ๋‹ค.

์˜ˆ๋ฅผ ๋“ค์–ด,

```sh
$ cd two-sum
$ touch Bumsu-Yi.py
```

๊ทธ ํŒŒ์ผ ์•ˆ์— ๋‹ต์•ˆ ์ฝ”๋“œ๋ฅผ ์ž‘์„ฑํ•˜๊ณ , ๋ณ€๊ฒฝ ์‚ฌํ•ญ์„ ์ปค๋ฐ‹ํ•ฉ๋‹ˆ๋‹ค.

์˜ˆ๋ฅผ ๋“ค์–ด,

```sh
$ git add Bumsu_Yi.py
$ git commit -am "two sum solution"
```

## ๋‹ต์•ˆ ์ฝ”๋“œ ์ œ์ถœ๋ฒ•

์ž‘์„ฑํ•œ ๋‹ตํ•œ ์ฝ”๋“œ๋ฅผ ๊ฐœ์ธ ์›๊ฒฉ ์ €์žฅ์†Œ๋กœ push ํ•ฉ๋‹ˆ๋‹ค.

```sh
$ git push origin main
```

๊ทธ ๋‹ค์Œ, ๊นƒํ—ˆ๋ธŒ ์›น์‚ฌ์ดํŠธ ๊ฐœ์ธ ์›๊ฒฉ์ €์žฅ์†Œ์— ๋“ค์–ด๊ฐ€ ์ขŒ์ƒ๋‹จ `Pull request`๋ฅผ ๋ˆ„๋ฅด๊ณ  `Pull request` ํƒญ์œผ๋กœ ์ด๋™ํ•œ ๋’ค, `New pull request` ๋ฒ„ํŠผ์„ ํด๋ฆญํ•ด์ค๋‹ˆ๋‹ค.

์ด์ œ ์ž‘์—…ํ•œ ์ฝ”๋“œ๋ฅผ ์›๋ณธ ์›๊ฒฉ ์ €์žฅ์†Œ๋กœ 'Merge' ํ•˜๊ธฐ ์œ„ํ•œ 'PR'์„ ์ƒ์„ฑํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

`Create pull request` ๋ฅผ ๋ˆ„๋ฅด๊ธฐ์— ์•ž์„œ, ์ƒ๋‹จ์— ์žˆ๋Š” `base repository` ์™€ `head repositry` ๊ฐ€ ๊ฐ๊ฐ ์›๋ณธ ์›๊ฒฝ ์ €์žฅ์†Œ์˜ main ๋ธŒ๋ Œ์น˜์™€ ๋ณธ์ธ์ด ์ž‘์—…ํ•œ ๋ธŒ๋ Œ์น˜๊ฐ€ ๋งž๋Š” ์ง€ ํ™•์ธํ•ด์ค๋‹ˆ๋‹ค.

ํ™•์ธ์ด ๋˜์—ˆ์œผ๋ฉด, `Create pull request`๋ฅผ ๋ˆ„๋ฅด๊ณ , `Title`์— **๋ณธ์ธ์˜ ๋””์Šค์ฝ”๋“œ ๋‹‰๋„ค์ž„์„ ํฌํ•จ ์‹œ์ผœ์ฃผ๊ณ ** `Create pull request` ๋ฒ„ํŠผ์„ ํด๋ฆญํ•ฉ๋‹ˆ๋‹ค.

๊ทธ๋Ÿฌ๋ฉด ๋””์Šค์ฝ”๋“œ์—๋„ ์•Œ๋ฆผ์ด ์˜ฌ๊ฒ๋‹ˆ๋‹ค. `Pull Request`๋ฅผ ์ƒ์„ฑํ•œ ๋’ค, ์šฐ์ธก `Project`ํƒญ์—์„œ `Iteration`์„ค์ •์„ ํ˜„์žฌ ์ง„ํ–‰ ์ฃผ์ฐจ์— ๋งž์ถฐ์ฃผ์‹œ๊ธฐ ๋ฐ”๋ž๋‹ˆ๋‹ค.

๋˜ํ•œ `Draft PR` ๊ธฐ๋Šฅ์„ ํ™œ์šฉํ•ด ํ•œ ๋ฒˆ์— ๋ชจ๋“  ์†”๋ฃจ์…˜์„ ์ œ์ถœํ•˜๊ธฐ๋ณด๋‹ค ๋ณธ์ธ์˜ ์ง„ํ–‰ ์ƒํ™ฉ์„ ์ฃผ๊ธฐ์ ์œผ๋กœ ์—…๋ฐ์ดํŠธํ•  ์ˆ˜ ์žˆ๋„๋ก ํ•ฉ๋‹ˆ๋‹ค.

`Draft` ๋ณ€ํ™˜์€ `Pull Request` ์ƒ์„ฑ ํ›„ ์šฐ์ธก ์ƒ๋‹จ `Still in progress?` ํ•ญ๋ชฉ์„ ํ†ตํ•ด ๋ณ€ํ™˜ํ•  ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

์ด์ œ ๋ณธ์ธ์ด ์ž‘์„ฑํ•œ ์†”๋ฃจ์…˜์„ ๋ฆฌ๋ทฐ๋ฐ›์„ ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค. ๋ฆฌ๋ทฐ๊ฐ€ `approved` ๋œ๋‹ค๋ฉด ๋ฉ”์ธ ์ €์žฅ์†Œ์— `Merge` ํ•˜์‹ค ์ˆ˜ ์žˆ์Šต๋‹ˆ๋‹ค.

Pull Request ์„ค๋ช…๋ž€์— ๋ฌธ์ œ๋ฅผ ํ•ด๊ฒฐํ•˜๋ฉด์„œ ์–ด๋ ค์› ๋˜ ๋ถ€๋ถ„์ด๋‚˜ ๋„์›€์ด ํ•„์š”ํ•œ ๋ถ€๋ถ„์— ๋Œ€ํ•ด ๋‚จ๊ฒจ์ฃผ์‹œ๋ฉด ๋‹ค๋ฅธ ๋ถ„๋“ค์ด ๋ฆฌ๋ทฐํ•  ๋•Œ ์ฐธ๊ณ ํ•  ์ˆ˜ ์žˆ์–ด์„œ ์ข‹๊ฒ ์ฃ ?

Pull Request์— ๋Œ€ํ•œ ๋ชจ๋“  ํ”„๋กœ์„ธ์Šค๊ฐ€ ์™„๋ฃŒ๋˜์—ˆ๋‹ค๋ฉด, ๋ณธ์ธ์˜ Pull Request๋Š” Pull Request ํ•˜๋‹จ `Merge pull request` ๋ฒ„ํŠผ์„ ํด๋ฆญํ•˜์—ฌ

์ง์ ‘ `Merge` ์ง„ํ–‰ํ•˜๋„๋ก ํ•ฉ๋‹ˆ๋‹ค.

## PR ๋‹ต์•ˆ ์ฝ”๋“œ ๋ฆฌ๋ทฐ๋ฒ•

๋ณธ์ธ์˜ Pull Request ์ž‘์„ฑ ์™„๋ฃŒ ํ›„, ๋ณธ์ธ ์งํ›„ Pull Request๋ฅผ ์ƒ์„ฑํ•œ ์Šคํ„ฐ๋””์›์˜ ์†”๋ฃจ์…˜์„ ๋ฆฌ๋ทฐํ•ฉ๋‹ˆ๋‹ค. ์˜ˆ๋ฅผ๋“ค์–ด,

![์˜ˆ์‹œ](images/337985716-307fdf57-90a7-4ccb-ab03-99a2d96fdc39.png)

์œ„ ํ˜•์‹์œผ๋กœ ๋ฆฌ๋ทฐ๋ฅผ ์ง„ํ–‰ํ•ฉ๋‹ˆ๋‹ค. ๋ฆฌ๋ทฐ ๋‚ด์šฉ์€ ๋‹น์‹œ๊นŒ์ง€ ์ œ์ถœ ์™„๋ฃŒ๋œ ์ฝ”๋“œ๋ฅผ ๊ธฐ๋ฐ˜์œผ๋กœ ๊ฐฏ์ˆ˜ ์ œํ•œ ์—†์ด ์ž์œ ๋กญ๊ฒŒ ์ž‘์„ฑํ•ด ์ฃผ์‹œ๋˜, ์œ ์ตํ•œ ๋ฆฌ๋ทฐ๋ฅผ ์ง€ํ–ฅํ•˜๋„๋ก ํ•ฉ๋‹ˆ๋‹ค.

๋ณธ์ธ์—๊ฒŒ ํ• ๋‹น๋œ ๋ฆฌ๋ทฐ ์™ธ ๋‹ค๋ฅธ ๋ฉค๋ฒ„์— ๋Œ€ํ•œ ์ฝ”๋“œ ๋ฆฌ๋ทฐ๋„ ์–ธ์ œ๋‚˜ ํ™˜์˜ํ•ฉ๋‹ˆ๋‹ค.

- [๋ฌธ์ œ ํ’€์ด ๊ฐ€์ด๋“œ](https://github.com/DaleStudy/leetcode-study/wiki/%EB%AC%B8%EC%A0%9C-%ED%92%80%EC%9D%B4-%EA%B0%80%EC%9D%B4%EB%93%9C)
- [๋‹ต์•ˆ ์ œ์ถœ ๊ฐ€์ด๋“œ](https://github.com/DaleStudy/leetcode-study/wiki/%EB%8B%B5%EC%95%88-%EC%A0%9C%EC%B6%9C-%EA%B0%80%EC%9D%B4%EB%93%9C)
- [์ฝ”๋“œ ๋ฆฌ๋ทฐ ๊ฐ€์ด๋“œ](https://github.com/DaleStudy/leetcode-study/wiki/%EC%BD%94%EB%93%9C-%EB%A6%AC%EB%B7%B0-%EA%B0%80%EC%9D%B4%EB%93%9C)
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
# ๋ฆฌํŠธ์ฝ”๋“œ ์Šคํ„ฐ๋””

๐Ÿ›ซ ํ•ด์™ธ ์ทจ์—…์„ ์œ„ํ•œ LeetCode ๋ฌธ์ œ ํ’€์ด + ์ธํ„ฐ๋ทฐ ์ค€๋น„ ์Šคํ„ฐ๋”” ๊ทธ๋ฃน
[![๐Ÿค– Automation](https://github.com/DaleStudy/leetcode-study/actions/workflows/automation.yaml/badge.svg)](https://github.com/DaleStudy/leetcode-study/actions/workflows/automation.yaml)
[![๐Ÿ”„ Integration](https://github.com/DaleStudy/leetcode-study/actions/workflows/integration.yaml/badge.svg)](https://github.com/DaleStudy/leetcode-study/actions/workflows/integration.yaml)

## ๋””์Šค์ฝ”๋“œ ์ปค๋ฎค๋‹ˆํ‹ฐ

์Šคํ„ฐ๋””์— ์ฐธ์—ฌํ•˜๊ณ  ์‹ถ์œผ์‹  ๋ถ„์€ ์•„๋ž˜ ๋งํฌ๋ฅผ ํ†ตํ•ด [๋””์Šค์ฝ”๋“œ ์„œ๋ฒ„](https://discord.gg/6TwzdnW6ze)์— ๋“ค์–ด์™€์ฃผ์„ธ์š”! ๐Ÿ˜ƒ

## ์Šคํ„ฐ๋”” ๋ฉค๋ฒ„
๐Ÿ›ซ ํ•ด์™ธ์ทจ์—…์„ ์œ„ํ•œ ์˜คํ”ˆ์†Œ์Šค ๊ธฐ๋ฐ˜ ์•Œ๊ณ ๋ฆฌ์ฆ˜ ์Šคํ„ฐ๋””

[์Šคํ„ฐ๋”” ์ฐธ์—ฌ ํฌ๋ง์ž ๋ฆฌ์ŠคํŠธ](https://github.com/DaleStudy/leetcode-study/discussions/52)
- [์›น์‚ฌ์ดํŠธ](https://www.dalestudy.com/)
- [๋ฆฌ๋”๋ณด๋“œ (๊ฐœ๋ฐœ ์ค‘)](https://leaderboard.dalestudy.com/)
- [์œ„ํ‚ค](https://github.com/DaleStudy/leetcode-study/wiki)
- [๊ฒŒ์‹œํŒ](https://github.com/DaleStudy/leetcode-study/discussions)
- [์ฑ„ํŒ…๋ฐฉ](https://discord.com/channels/775115965964222492/1229860988170403901)

## ๊ธฐ์—ฌ ๋ฐฉ๋ฒ•

์Šคํ„ฐ๋”” ๋ฉค๋ฒ„๋“ค์€ ์ž์‹ ์ด ํ•ด๊ฒฐํ•œ LeetCode ๋ฌธ์ œ์— ๋Œ€ํ•œ ๋‹ต์•ˆ ์ฝ”๋“œ๋ฅผ ์ œ์ถœํ•จ์œผ๋กœ์จ ์ž์—ฐ์Šค๋Ÿฝ๊ฒŒ ๋ณธ ํ”„๋กœ์ ํŠธ์— ๊ธฐ์—ฌํ•˜์‹œ๊ฒŒ ๋ฉ๋‹ˆ๋‹ค.
ํ”„๋กœ์ ํŠธ์— ๊ธฐ์—ฌํ•˜๋Š” ์ž์„ธํ•œ ๋ฐฉ๋ฒ•์€ ๋ณ„๋„์˜ [๊ฐ€์ด๋“œ ๋ฌธ์„œ](./CONTRIBUTING.md)๋ฅผ ์ฐธ๊ณ  ๋ฐ”๋ž๋‹ˆ๋‹ค.
## ํ”„๋กœ์ ํŠธ
- [1๊ธฐ](https://github.com/orgs/DaleStudy/projects/1/views/1): Apr 21, 2024 - Aug 10, 2024
- [2๊ธฐ](https://github.com/orgs/DaleStudy/projects/3/views/3): Aug 11, 2024 - Nov 23, 2024

0 comments on commit 65779af

Please sign in to comment.