Skip to content

Commit 3e09583

Browse files
authored
README.md, CONTRIBUTING.md, .github 등 정리 (PyTorchKorea#11) (PyTorchKorea#14)
* 행동 강령 문서 이동에 따른 반영 (PyTorchKorea#12) * 커뮤니티 문서 추가 및 개선(PyTorchKorea#11)
1 parent 1782ce5 commit 3e09583

File tree

3 files changed

+90
-58
lines changed

3 files changed

+90
-58
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## 라이선스 동의
2+
_변경해주시는 내용에 BSD 3항 라이선스가 적용됨을 동의해주셔야 합니다._<br />
3+
_더 자세한 내용은 [기여하기 문서](https://github.com/PyTorchKorea/pytorch.kr/blob/master/CONTRIBUTING.md)를 참고해주세요._<br />
4+
_동의하시면 아래 `[ ]``[x]`로 만들어주세요._<br />
5+
6+
- [ ] 기여하기 문서를 확인하였으며, 본 PR 내용에 BSD 3항 라이선스가 적용됨에 동의합니다.
7+
8+
## 관련 이슈 번호
9+
_이 Pull Request와 관련있는 이슈 번호를 적어주세요._<br />
10+
_이슈 또는 PR 번호 앞에 #을 붙이시면 제목을 바로 확인하실 수 있습니다. (예. #999 )_
11+
12+
- **이슈 번호**: #(숫자)
13+
14+
## PR 종류
15+
_이 PR에 해당되는 종류 앞의 `[ ]``[x]`로 변경해주세요._<br />
16+
- [ ] 홈페이지 내의 문서를 추가/개선하는 기여
17+
- [ ] 홈페이지 자체를 개선하거나 변경하는 기여
18+
- [ ] 위 종류에 포함되지 않는 기여
19+
20+
## PR 설명
21+
_이 PR로 무엇이 달라지는지 대략적으로 알려주세요._
22+

CONTRIBUTING.md

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# 파이토치 한국 사용자 모임 홈페이지 기여하기
2+
3+
파이토치 한국 사용자 모임 홈페이지 저장소에 방문해주셔서 감사합니다. \
4+
이 문서는 파이토치 한국 사용자 모임 홈페이지에 기여하는 방법을 안내합니다.
5+
6+
## 기여하기 개요
7+
8+
[이 저장소](https://github.com/PyTorchKorea/pytorch.kr)[파이토치 한국 사용자 모임 홈페이지](https://pytorch.kr)를 위한 곳으로, [PyTorch 공식 홈페이지 저장소](https://github.com/pytorch/pytorch.github.io)를 복제하여 만들었습니다.
9+
10+
## 기여 결과물의 라이선스 동의
11+
12+
파이토치 한국 사용자 모임 홈페이지는 [PyTorch 공식 홈페이지 저장소](https://github.com/pytorch/pytorch.github.io)와 동일한 [BSD-3항 라이선스](https://github.com/PyTorchKorea/pytorch.kr/blob/master/LICENSE)를 따릅니다. \
13+
따라서 기여하신 모든 내용에 [BSD-3항 라이선스](https://github.com/PyTorchKorea/pytorch.kr/blob/master/LICENSE)가 적용됨을 인지하시고 동의하시는 경우에만 기여에 참여해주세요.
14+
15+
## 기여하기 절차
16+
17+
모든 기여는 [본 저장소에 이슈](https://github.com/PyTorchKorea/pytorch.kr/issues/new)를 남긴 후 [Pull Request를 보내는 것](https://github.com/PyTorchKorea/pytorch.kr/pulls)으로 합니다. \
18+
이 과정을 통해 Pull Request를 위한 Commit을 만들기 전에 이슈를 통해 해당 내용에 기여가 필요한지 여부를 확인하고 협의하셔야 합니다. \
19+
(물론 이슈를 남기셨다고 해서 반드시 해당 문제를 개선하셔야 하는 것은 아니니, 마음 편히 이슈를 남겨주세요. :))
20+
21+
## 참고 문서
22+
23+
GitHub에서 기여를 하는 것에 익숙하지 않으시다면 아래 문서들을 참고해주세요.
24+
25+
* [GitHub의 프로젝트에 기여하기 도움말](https://docs.github.com/en/get-started/quickstart/contributing-to-projects)
26+
* [GitHub의 저장소 복제 관련 도움말](https://help.github.com/en/github/getting-started-with-github/fork-a-repo)
27+
* [GitHub의 Pull Request에 대한 소개 문서](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
28+
* [GitHub의 Pull Request 리뷰 요청 관련 도움말](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)

README.md

+40-58
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,69 @@
1-
# pytorch.org site
1+
# 파이토치 한국 사용자 모임 홈페이지
22

3-
[https://pytorch.org](https://pytorch.org)
3+
## 개요
44

5-
A static website built in [Jekyll](https://jekyllrb.com/) and [Bootstrap](https://getbootstrap.com/) for [PyTorch](https://pytorch.org/), and its tutorials and documentation.
5+
[파이토치 한국 사용자 모임 홈페이지](https://pytorch.kr) 저장소에 오신 것을 환영합니다! \
6+
파이토치 한국 사용자 모임 홈페이지는 [PyTorch 공식 홈페이지 저장소](https://github.com/pytorch/pytorch.github.io)를 복제하여 만들었습니다. \
7+
홈페이지 빌드를 위해 [Jekyll](https://jekyllrb.com/)[Bootstrap](https://getbootstrap.com/) 등을 사용하고 있습니다.
68

7-
## Prerequisites
9+
## 빌드하기
810

9-
Install the following packages before attempting to setup the project:
11+
이 저장소를 빌드하기 위해 필요한 절차를 안내합니다.
12+
13+
### 필요 도구
14+
15+
이 저장소를 빌드하기 위해서는 아래 도구들의 필요합니다.
1016

1117
- [rbenv](https://github.com/rbenv/rbenv)
1218
- [ruby-build](https://github.com/rbenv/ruby-build)
1319
- [nvm](https://github.com/creationix/nvm)
1420

15-
On OSX, you can use:
21+
macOS에서 [homebrew](https://brew.sh/)를 사용하신다면, 아래 명령어로 설치하실 수 있습니다:
1622

23+
```sh
24+
brew install rbenv ruby-build nvm
1725
```
18-
brew install rbenv ruby-build nvm
19-
```
20-
21-
## Setup
22-
23-
#### Install required Ruby version:
2426

25-
```
26-
#### You only need to run these commands if you are missing the needed Ruby version.
27+
### 빌드 절차
2728

28-
rbenv install `cat .ruby-version`
29-
gem install bundler -v 1.16.3
30-
rbenv rehash
29+
#### ruby 및 bundler, 필요 패키지 설치
3130

32-
####
31+
아래 명령어로 이 저장소에서 필요로 하는 ruby 버전에 맞춰 ruby와 bundler, 필요 패키지들을 설치합니다.
3332

34-
bundle install
35-
rbenv rehash
33+
```sh
34+
rbenv install `cat .ruby-version` # ruby 설치
35+
gem install bundler -v 2.2.17 # bundler 설치
36+
rbenv rehash
37+
bundle install # 필요 패키지 설치
38+
rbenv rehash
3639
```
3740

38-
#### Install required Node version
41+
#### node.js 및 필요 패키지 설치
3942

40-
```
41-
nvm install
42-
nvm use
43-
```
43+
아래 명령어로 이 저장소에서 필요로 하는 node.js 버전에 맞춰 node.js 및 yarn, 필요 패키지들을 설치합니다.
4444

45-
#### Install Yarn
46-
47-
```
48-
brew install yarn --ignore-dependencies
49-
yarn install
45+
```sh
46+
nvm install # node.js 설치
47+
nvm use # node.js 버전 적용
48+
npm install yarn # 패키지 도구 설치
49+
yarn install # 필요 패키지 설치
5050
```
5151

52-
## Local Development
52+
#### 홈페이지 빌드
5353

54-
To run the website locally for development:
54+
아래 명령어로 jekyll을 사용하여 빌드합니다. 빌드 결과물은 `./_site` 디렉토리에 저장됩니다.
5555

56+
```sh
57+
make build
5658
```
57-
make serve
58-
```
59-
60-
Then navigate to [localhost:4000](localhost:4000).
61-
62-
Note the `serve` task is contained in a `Makefile` in the root directory. We are using `make` as an alternative to the standard `jekyll serve` as we want to run `yarn`, which is not included in Jekyll by default.
63-
64-
### Building the Static Site
65-
66-
To build the static website from source:
67-
68-
```
69-
make build
70-
```
71-
72-
This will build the static site at `./_site`. This directory is not tracked in git.
7359

74-
## Deployments
60+
## 배포하기
7561

76-
The website is hosted on [Github Pages](https://pages.github.com/) at [https://pytorch.org](https://pytorch.org).
62+
[파이토치 한국 사용자 모임 홈페이지](https://pytorch.kr)[GitHub Pages](https://pages.github.com/)를 사용합니다. \
63+
홈페이지는 [GitHub Actions](https://docs.github.com/en/actions)를 사용하여 자동으로 빌드 및 `gh-pages` 브랜치에 배포됩니다.
7764

78-
To deploy changes, merge your latest code into the `site` branch. A build will be automatically built and committed to the `master` branch via a CircleCI job.
7965

80-
To view the status of the build visit [https://circleci.com/gh/pytorch/pytorch.github.io](https://circleci.com/gh/pytorch/pytorch.github.io).
66+
## 기여하기
8167

82-
## Contributing to PyTorch Documentation and Tutorials
83-
* You can find information about contributing to PyTorch documentation in the
84-
PyTorch repo [README.md](https://github.com/pytorch/pytorch/blob/master/README.md) file.
85-
* Information about contributing to PyTorch Tutorials can be found in the
86-
tutorials [README.md](https://github.com/pytorch/tutorials/blob/master/README.md).
87-
* Additional contribution information can be found in [PyTorch CONTRIBUTING.md](https://github.com/pytorch/pytorch/blob/master/CONTRIBUTING.md).
68+
홈페이지에서 잘못된 내용 또는 변경 / 추가하고 싶은 내용이 있다면 이 저장소에 기여하실 수 있습니다. \
69+
[기여하기](CONTRIBUTING.md) 문서를 참고해주세요.

0 commit comments

Comments
 (0)