Skip to content

Commit 65779af

Browse files
committed
tidy up docs
1 parent 25a0e1f commit 65779af

File tree

2 files changed

+14
-82
lines changed

2 files changed

+14
-82
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,5 @@
11
# 기여 방법
22

3-
## 답안 코드 작성법
4-
5-
참조 링크 :
6-
[깃허브(GitHub)에서의 오픈 소스 프로젝트 기여를 위한 초보자 가이드](https://seongjin.me/how-to-contribute-to-open-source/amp/)
7-
8-
먼저, 현재 페이지 우상단에 있는 버튼들 중 `Fork` 버튼 클릭하여 개인 원격 저장소로 복사해줍니다.
9-
10-
개인 로컬 저장소로 `Fork`한 개인 원격 저장소 코드를 클론합니다,
11-
12-
예를 들어,
13-
14-
```sh
15-
$ git clone https://github.com/Bumsu-Yi/leetcode-study.git
16-
```
17-
18-
푸시려는 문제의 폴더에서 자기 GitHub 유저네임으로 파일을 생성합니다.
19-
20-
예를 들어,
21-
22-
```sh
23-
$ cd two-sum
24-
$ touch Bumsu-Yi.py
25-
```
26-
27-
그 파일 안에 답안 코드를 작성하고, 변경 사항을 커밋합니다.
28-
29-
예를 들어,
30-
31-
```sh
32-
$ git add Bumsu_Yi.py
33-
$ git commit -am "two sum solution"
34-
```
35-
36-
## 답안 코드 제출법
37-
38-
작성한 답한 코드를 개인 원격 저장소로 push 합니다.
39-
40-
```sh
41-
$ git push origin main
42-
```
43-
44-
그 다음, 깃허브 웹사이트 개인 원격저장소에 들어가 좌상단 `Pull request`를 누르고 `Pull request` 탭으로 이동한 뒤, `New pull request` 버튼을 클릭해줍니다.
45-
46-
이제 작업한 코드를 원본 원격 저장소로 'Merge' 하기 위한 'PR'을 생성할 수 있습니다.
47-
48-
`Create pull request` 를 누르기에 앞서, 상단에 있는 `base repository``head repositry` 가 각각 원본 원경 저장소의 main 브렌치와 본인이 작업한 브렌치가 맞는 지 확인해줍니다.
49-
50-
확인이 되었으면, `Create pull request`를 누르고, `Title`**본인의 디스코드 닉네임을 포함 시켜주고** `Create pull request` 버튼을 클릭합니다.
51-
52-
그러면 디스코드에도 알림이 올겁니다. `Pull Request`를 생성한 뒤, 우측 `Project`탭에서 `Iteration`설정을 현재 진행 주차에 맞춰주시기 바랍니다.
53-
54-
또한 `Draft PR` 기능을 활용해 한 번에 모든 솔루션을 제출하기보다 본인의 진행 상황을 주기적으로 업데이트할 수 있도록 합니다.
55-
56-
`Draft` 변환은 `Pull Request` 생성 후 우측 상단 `Still in progress?` 항목을 통해 변환할 수 있습니다.
57-
58-
이제 본인이 작성한 솔루션을 리뷰받을 수 있습니다. 리뷰가 `approved` 된다면 메인 저장소에 `Merge` 하실 수 있습니다.
59-
60-
Pull Request 설명란에 문제를 해결하면서 어려웠던 부분이나 도움이 필요한 부분에 대해 남겨주시면 다른 분들이 리뷰할 때 참고할 수 있어서 좋겠죠?
61-
62-
Pull Request에 대한 모든 프로세스가 완료되었다면, 본인의 Pull Request는 Pull Request 하단 `Merge pull request` 버튼을 클릭하여
63-
64-
직접 `Merge` 진행하도록 합니다.
65-
66-
## PR 답안 코드 리뷰법
67-
68-
본인의 Pull Request 작성 완료 후, 본인 직후 Pull Request를 생성한 스터디원의 솔루션을 리뷰합니다. 예를들어,
69-
70-
![예시](images/337985716-307fdf57-90a7-4ccb-ab03-99a2d96fdc39.png)
71-
72-
위 형식으로 리뷰를 진행합니다. 리뷰 내용은 당시까지 제출 완료된 코드를 기반으로 갯수 제한 없이 자유롭게 작성해 주시되, 유익한 리뷰를 지향하도록 합니다.
73-
74-
본인에게 할당된 리뷰 외 다른 멤버에 대한 코드 리뷰도 언제나 환영합니다.
75-
3+
- [문제 풀이 가이드](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)
4+
- [답안 제출 가이드](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)
5+
- [코드 리뷰 가이드](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)

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
# 리트코드 스터디
22

3-
🛫 해외 취업을 위한 LeetCode 문제 풀이 + 인터뷰 준비 스터디 그룹
3+
[![🤖 Automation](https://github.com/DaleStudy/leetcode-study/actions/workflows/automation.yaml/badge.svg)](https://github.com/DaleStudy/leetcode-study/actions/workflows/automation.yaml)
4+
[![🔄 Integration](https://github.com/DaleStudy/leetcode-study/actions/workflows/integration.yaml/badge.svg)](https://github.com/DaleStudy/leetcode-study/actions/workflows/integration.yaml)
45

5-
## 디스코드 커뮤니티
66

7-
스터디에 참여하고 싶으신 분은 아래 링크를 통해 [디스코드 서버](https://discord.gg/6TwzdnW6ze)에 들어와주세요! 😃
87

9-
## 스터디 멤버
8+
🛫 해외취업을 위한 오픈소스 기반 알고리즘 스터디
109

11-
[스터디 참여 희망자 리스트](https://github.com/DaleStudy/leetcode-study/discussions/52)
10+
- [웹사이트](https://www.dalestudy.com/)
11+
- [리더보드 (개발 중)](https://leaderboard.dalestudy.com/)
12+
- [위키](https://github.com/DaleStudy/leetcode-study/wiki)
13+
- [게시판](https://github.com/DaleStudy/leetcode-study/discussions)
14+
- [채팅방](https://discord.com/channels/775115965964222492/1229860988170403901)
1215

13-
## 기여 방법
14-
15-
스터디 멤버들은 자신이 해결한 LeetCode 문제에 대한 답안 코드를 제출함으로써 자연스럽게 본 프로젝트에 기여하시게 됩니다.
16-
프로젝트에 기여하는 자세한 방법은 별도의 [가이드 문서](./CONTRIBUTING.md)를 참고 바랍니다.
16+
## 프로젝트
17+
- [1기](https://github.com/orgs/DaleStudy/projects/1/views/1): Apr 21, 2024 - Aug 10, 2024
18+
- [2기](https://github.com/orgs/DaleStudy/projects/3/views/3): Aug 11, 2024 - Nov 23, 2024

0 commit comments

Comments
 (0)