Skip to content

Commit

Permalink
docs: issue 전략 링크 정리 (#692)
Browse files Browse the repository at this point in the history
* docs(ci): requirements.txt 사용

* docs: 이슈 및 브랜치 전략 링크로 정리
  • Loading branch information
scarf005 authored Aug 23, 2023
1 parent 32547b9 commit 6132e3c
Show file tree
Hide file tree
Showing 4 changed files with 67 additions and 24 deletions.
15 changes: 6 additions & 9 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,10 @@ jobs:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: 3.9.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v3
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
clear-keys: |
mkdocs-material-
- run: pip install mkdocs-material
python-version: 3.10.x
cache: pip
- run: pip install -r requirements.txt
- run: mkdocs gh-deploy --force

# 과정 참고:
# https://github.com/actions/setup-python/tree/v4/#caching-packages-dependencies
26 changes: 20 additions & 6 deletions docs/docs/gitflow.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,32 @@
# Git Flow Strategy

집현전 백엔드는 배포용 브랜치인 `main`과 개발용 브랜치인 `develop` 둘로 나뉜
[git-flow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) 전략을
사용하고 있습니다.

## `main` 브랜치
- 완성된 기능들이 들어있는 가장 최신의 브랜치입니다. develop 브랜치에서만 푸시를 받습니다.

- <server.42library.kr>에 배포중인 서버의 소스코드가 들어있는 브랜치입니다.
- `develop` 브랜치에서 머지하면 AWS에 자동으로 배포됩니다.

## `develop` 브랜치
- 개발중인 기능들이 이슈 단위로 완료되어 들어오는 브랜치입니다. issue 브랜치에서 푸시를 받습니다.

- 개발중인 기능들이 이슈 단위로 완료되어 들어오는 브랜치입니다.
- issue 브랜치에서 푸시를 받습니다.

## issue 브랜치 (eg. `42-issue-추가`)

![](https://github.com/jiphyeonjeon-42/backend/assets/54838975/cf844b41-1690-44b2-9bf5-7ad69dbc401a)

연관 문서: [이슈 전략](./issue_strategy.md)

- 개별 이슈에 대한 개발이 진행되는 브랜치입니다.
- 이슈에서 create_branch 기능을 이용하여 자동으로 생성합시다.
- 여러 이슈로 이루어진 이슈는 여러 이슈를 가진 이슈로 묶어 Umbrella issue 로 관리합니다. [이슈 전략 페이지로 링크]
- 이슈 탭에서 `Create a Branch` 버튼을 눌러 쉽게 생성 가능합니다.
- 진행 기간이 긴 (~1주일) 이슈는 [우산 이슈](./issue_strategy.md)를 사용해 관리합니다.
- 이슈를 해결한 후 pull request 를 생성합니다.
- 리뷰를 받은 후 **_squash merge_** 로 develop 브랜치에 merge 합니다.


## 개인 브랜치
둘 이상의 인원이 하나의 issue 브랜치에서 작업할 경우에 `issue/23_jolim`같은 방식으로 이름지어서 푸시합니다.

둘 이상의 인원이 하나의 issue 브랜치에서 작업할 경우에 `issue/23_jolim`같은 방식으로 이름지어서
푸시합니다.
15 changes: 6 additions & 9 deletions docs/docs/issue_strategy.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
# 이슈 전략

## 여러 이슈를 관리하는 이슈 ☂️
- 제목에 :open_unbrella: 라는 ☂️ 모양의 이모지를 붙이고 label 도 umbrella 이슈로 설정해주세요
- 하나의 이슈는 하나의 풀 리퀘스트로 만들어지는데, 규모가 큰 이슈의 경우 umbrella 이슈로 묶어서 관리합니다.
- umbrella 이슈 내부에서 체크리스트에 이슈를 링킹할 수 있습니다.
- 링킹하는 방법은 `- [ ] #'이슈번호'` 를 입력하면 링크할 수 있습니다.
- 여러 이슈를 묶은 이슈는 issue 페이지 우측 하단의 pin 기능을 활용하여 쉽게 찾아가도록 합시다.


## 개별 이슈

- 개별 이슈의 이름은 자유롭게 설정합니다. 그리고 어떤 이슈인지 자세히 명세하도록 합니다.
- 개별 이슈마다 브랜치 생성은 깃허브 우측의 브랜치 자동생성 기능을 이용하도록 합시다.
- **_개별 이슈들은 각각 브랜치 안에서 관리하고 squash merge 를 이용해서 develop 브랜치에 pull request 를 날리도록 합시다!_**

[참고: 415 이슈](https://github.com/jiphyeonjeon-42/backend/issues/415)
[참고: 415 이슈](https://github.com/jiphyeonjeon-42/backend/issues/415)

## [우산 이슈 ☂️](./convention/umbrella.md)

장기간 (~1주일) 진행되는 이슈는 우산 이슈를 이용해 태스크리스트 형태로 관리합니다.
35 changes: 35 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
Babel==2.12.1
beautifulsoup4==4.12.2
certifi==2023.7.22
charset-normalizer==3.2.0
click==8.1.7
colorama==0.4.6
cssselect==1.2.0
ghp-import==2.1.0
idna==3.4
Jinja2==3.1.2
lxml==4.9.3
Markdown==3.4.4
markdown2==2.4.10
MarkupSafe==2.1.3
mergedeep==1.3.4
mkdocs==1.5.2
mkdocs-material==9.2.1
mkdocs-material-extensions==1.1.1
packaging==23.1
paginate==0.5.6
pathspec==0.11.2
platformdirs==3.10.0
Pygments==2.16.1
pymdown-extensions==10.1
pyquery==2.0.0
python-dateutil==2.8.2
PyYAML==6.0.1
pyyaml_env_tag==0.1
readtime==3.0.0
regex==2023.8.8
requests==2.31.0
six==1.16.0
soupsieve==2.4.1
urllib3==2.0.4
watchdog==3.0.0

0 comments on commit 6132e3c

Please sign in to comment.