Skip to content

기여 가이드 문서 추가 #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

이 변경 사항은 본 PR과 직접적인 상관이 없습니다. 제가 이전 PR(#30)에서 실수로 파일을 잘못된 위치에 두어서 단순히 파일을 옮바른 위치로 이동시키고 있습니다.

File renamed without changes.
56 changes: 56 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# 기여 방법

## 답안 코드 작성법

참조 링크 :
https://seongjin.me/how-to-contribute-to-open-source/amp/
Copy link
Contributor

@dev-jonghoonpark dev-jonghoonpark Apr 29, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[https://seongjin.me/how-to-contribute-to-open-source/amp/](https://seongjin.me/how-to-contribute-to-open-source/amp/)

로 바꾸면 어떨까요?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

느낌표 제거했습니다 ; )


먼저, 현재 페이지 우상단에 있는 버튼들 중 `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` 버튼을 클릭합니다.

그러면 디스코드에도 알림이 올겁니다.

이제 본인이 작성한 솔루션을 리뷰 받을 수 있습니다. 리뷰가 `approved` 된다면 메인 저장소를 `Merge` 하실 수 있습니다.

Pull Request 설명란에 문제를 해결하면서 어려웠던 부분이나 도움이 필요한 부분에 대해서 남겨주시면 다른 분들이 리뷰할 때 참고할 수 있어서 좋겠죠?
55 changes: 3 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,56 +12,7 @@ https://discord.gg/6TwzdnW6ze

https://github.com/DaleStudy/leetcode-study/issues/7

## 답안 코드 작성법
참조 링크 :
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` 버튼을 클릭합니다.

그러면 디스코드에도 알림이 올겁니다.

이제 본인이 작성한 솔루션을 리뷰 받을 수 있습니다. 리뷰가 `approved` 된다면 메인 저장소를 `Merge` 하실 수 있습니다.

Pull Request 설명란에 문제를 해결하면서 어려웠던 부분이나 도움이 필요한 부분에 대해서 남겨주시면 다른 분들이 리뷰할 때 참고할 수 있어서 좋겠죠?
스터디 멤버들은 자신이 해결한 LeetCode 문제에 대한 답안 코드를 제출함으로써 자연스럽게 본 프로젝트에 기여하시게 됩니다.
프로젝트에 기여하는 자세한 방법은 별도의 [가이드 문서](/.CONTRIBUTING.md)를 참고 바랍니다.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/.CONTRIBUTING.md

. 의 위치가 / 와 바뀐것으로 생각되는데 한 번 확인 부탁드립니다...!

@DaleSeo