Skip to content

Commit 703c997

Browse files
2yunseong2yunseong
committed
docs: 문서 기여 가이드 및 템플릿 최신화
- CONTRIBUTING.md 새로 제작 - 기존 버그리포트 삭제 > md로 변경 - 버그수정, 버그리포트 통합 -> 버그리포트
1 parent 181babc commit 703c997

7 files changed

+260
-71
lines changed

‎.github/ISSUE_TEMPLATE/기능구현.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
---
22
name: 기능구현
33
about: 새로운 기능 이슈 등록
4-
title: "[FE/BE] feat:"
4+
title: '[FE] feat:'
55
labels: 기능구현 ✅
66
assignees: ''
7-
87
---
98

10-
## 구현 기능
9+
## 관련 이슈
10+
11+
<!--- 관련 이슈를 작성해주세요. --->
12+
13+
- #<issue-number>
1114

12-
<br/>
15+
## 어떤 이슈인가요?
1316

14-
## 작업 내용
17+
<!--- 왜 이 이슈가 발의되었는지에 대해 설명해주세요. --->
1518

16-
<br/>
19+
## 주의할 부분은 무엇인가요?
20+
21+
<!--- 다른 팀원이 이슈를 진행하는 상황에서 유의할 점에 대해 작성해주세요.--->
1722

1823
## 체크리스트
1924

2025
- [ ] `assignee` 설정 (선택)
2126
- [ ] `labels` 설정
22-
- [ ] `milestone` 설정
23-
24-
<br/>
25-
26-
## 주의사항

‎.github/ISSUE_TEMPLATE/리팩터링.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11
---
22
name: 리팩터링
33
about: 리팩터링 이슈 등록
4-
title: "[FE/BE] refactor:"
4+
title: '[FE] refactor:'
55
labels: "리팩터링 \U0001F528"
66
assignees: ''
7-
87
---
98

10-
## 리팩터링 내용
9+
## 어떤 부분을 리팩터링 하나요?
1110

12-
<br/>
11+
<!---
12+
리팩터링할 부분과 곳을, 그리고 어떻게 리팩터링할 지 기술합니다.
13+
--->
14+
15+
## 리팩터링이 필요한 이유가 무엇인가요?
16+
17+
<!---
18+
리팩터링을 진행하면서 얻는 이점을 기술
19+
혹은 관련 근거를 논의
20+
--->
1321

1422
## 체크리스트
1523

1624
- [ ] `assignee` 설정 (선택)
1725
- [ ] `labels` 설정
18-
- [ ] `milestone` 설정
1926

2027
<br/>
21-
22-
## 주의사항

‎.github/ISSUE_TEMPLATE/버그리포트.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: 버그리포트
3+
about: 버그 제보 및 리포트
4+
title: '[FE] bug:'
5+
labels: "버그발생 \U0001F6A8"
6+
assignees: ''
7+
---
8+
9+
## As-is
10+
11+
<!---
12+
현재 상황에 대해 자세하게 설명해주세요.
13+
- 어떤 페이지에서
14+
- 어떤 동작을 하였을 때
15+
- 어떤 액션이 일어나는 지
16+
--->
17+
18+
## To-be
19+
20+
<!---
21+
원하는 결과에 대해 기술해주세요.
22+
- 어떠한 동작하기를 기대
23+
- 어떻게 동작해야 한다. 등등..
24+
--->

‎.github/ISSUE_TEMPLATE/버그리포트.yml

Lines changed: 0 additions & 25 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/버그수정.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 54 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,61 @@
1-
## 주요 변경사항
1+
## 관련 이슈
22

3-
## 리뷰어에게...
3+
<!---
4+
<issue_number>부분을 지우고, 관련 이슈 번호를 작성
5+
--->
46

5-
## 관련 이슈
7+
- closes #<issue_number>
8+
9+
### 작업 분류
10+
11+
<!---
12+
버그 수정: 버그 수정에 대한 PR일 경우
13+
신규 기능 추가: 논의된 새로운 기능을 추가하였을 경우
14+
프로젝트 구조 변경: 디렉터리 구조나 코드 계층(추상화 레벨)이 변경된 경우
15+
코드 스타일 변경: 린트 규칙, 코딩 컨벤션 등의 변경
16+
문서 수정: 이슈 템플릿, README, CONTRIBUTE.md 등 프로젝트 관련 문서가 변경될 경우
17+
--->
18+
19+
- [ ] 버그 수정
20+
- [ ] 신규 기능 추가
21+
- [ ] 프로젝트 구조 변경
22+
- [ ] 코드 스타일 변경
23+
- [ ] 기존 기능 개선
24+
- [ ] 문서 수정
25+
26+
## PR을 통해 해결하려는 문제가 무엇인가요? 🚀
27+
28+
<!---
29+
이 PR은 어떤 문제를 해결하는지, 리뷰어가 알 수 있게 기술해주세요.
30+
--->
31+
32+
## PR에서 핵심적으로 변경된 부분이 어떤 부분인가요? 👀
33+
34+
<!---
35+
해결하려는 문제에 연관된 핵심 변경사항을 기술해주세요.
36+
--->
37+
38+
## 핵심 변경사항 이외 추가적으로 변경된 사항이 있나요? ➕
39+
40+
<!---
41+
핵심 변경사항 이외 변경한 내용을 기술해주세요.
42+
--->
43+
44+
## 추가적으로, 리뷰어가 리뷰하며 알아야 할 정보가 있나요? 🙌
45+
46+
<!---
47+
참고링크, 리뷰 시 궁금한 점, 주의할 점 등등..
48+
리뷰어가 리뷰 전에 알아야 할 정보를 기술해주세요.
49+
--->
50+
51+
## 이런 부분을 신경써서 봐주셨으면 좋겠어요. 🙋🏻‍♂️
652

7-
closes
53+
<!---
54+
문제를 해결하며 궁금했던 점, 리뷰어와 같이 이야기 나눠보고 싶은 점
55+
--->
856

9-
## 체크리스트
57+
## 체크리스트 ✅
1058

1159
- [ ] `reviewers` 설정
60+
- [ ] `assignees` 설정
1261
- [ ] `label` 설정
13-
- [ ] `milestone` 설정

‎CONTRIBUTING.md

Lines changed: 159 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
# Contribution Guidelines
2+
3+
먼저, 에코노베이션 신입모집 플랫폼에 기여해주셔서 감사합니다! 이 문서는 기여를 하기 위해 지켜야 할 규칙에 대해 나타납니다.
4+
5+
## Contributor
6+
7+
이 프로젝트는 에코노 회원들에 의해서만 기여를 할 수 있습니다. 에코노 회원이 아닌 제3자가 기여할 시, reject될 수 있음을 유의해주세요.
8+
9+
## Documentation
10+
11+
아래 문서들은 여러분의 기여에 도움을 주는 문서들 입니다.
12+
13+
- [Discussions](https://github.com/JNU-econovation/econo-recruit-fe/discussions)
14+
- 프로젝트에 관련된 여러 논의를 볼 수 있습니다.
15+
- [Wiki](https://github.com/JNU-econovation/econo-recruit-fe/wiki)
16+
- 코딩컨벤션, 테스트 작성 가이드 등을 참고할 수 있습니다.
17+
- Econovation Recruit Manual
18+
- 이 문서는 동아리 원이 아닌 외부인은 열람이 불가합니다. 따라서, 관리부 혹은 프로젝트 관리자에게 문의해주시기 바랍니다.
19+
20+
## Project Setup
21+
22+
1. 프로젝트 루트 디렉토리 기준으로, `/frontend` 디렉토리로 이동합니다.
23+
24+
```
25+
cd frontend
26+
```
27+
28+
2. pnpm을 통해 설치합니다.(사전에 node 또한 설치되어야 합니다.) 이 때 권장되는 버전은 다음과 같습니다.
29+
30+
- `pnpm`: 8.10.2
31+
- `node`: v20.9.0
32+
33+
\*\*빌드 시, `bun`등 다른 런타임을 사용해도 되나, 권장하지 않습니다.
34+
35+
```
36+
pnpm install
37+
```
38+
39+
3. 적절한 `.env`를 `/frontend` 디렉토리에 저장합니다. 이 때, `.env`에 관한 내용은 관리자에게 문의해주세요.
40+
41+
4-1. 프로젝트를 개발환경에서 실행하고 싶을 시, 다음의 명령어를 수행합니다.
42+
43+
```
44+
pnpm run dev
45+
```
46+
47+
4-2. 프로젝트를 로컬에서 운영환경으로 서빙하고 싶을 시, 다음의 명령어를 수행합니다.
48+
49+
```
50+
pnpm run build
51+
pnpm start
52+
```
53+
54+
> ⚠️ 모든 명령어는 `/frontend` 디렉토리 내에서 수행되어야 함을 주의하세요.
55+
56+
## Open Issues
57+
58+
프로젝트에 어떤 이슈를 열고 싶을 때는, [Issue Template](https://github.com/JNU-econovation/econo-recruit-fe/issues/new/choose) 를 꼭 따라주세요.
59+
60+
원하는 이슈 템플릿이 없다면 자유롭게 [Discussions](https://github.com/JNU-econovation/econo-recruit-fe/discussions)에 발의 해주시기 바랍니다.
61+
62+
## Committing and Pushing changes
63+
64+
이 프로젝트는 Github Flow를 통해 관리되고 있습니다.
65+
66+
### Creating Branch
67+
68+
원하는 이슈를 통해 브랜치를 생성해주세요. 브랜치 이름은 다음의 형식을 권장합니다.
69+
70+
```
71+
<작업유형>/<issue_number>-<작업에 대한 제목>
72+
```
73+
74+
**예시**
75+
76+
```
77+
feat/123-pass-status-page-markup
78+
docs/234-enhancement-readme-content
79+
```
80+
81+
### Create Commit
82+
83+
커밋 컨벤션은 다음과 같습니다.
84+
85+
- `feat`: 기능 추가/개선 등
86+
- `refactor`: 리팩터링(기존과 동일한 동작을 하되 코드 구조가 변경된 경우)
87+
- `fix`: 버그에 대한 수정
88+
- `style`: 린팅, 프리티어, 코드 스타일 등의 수정
89+
- `test`: 테스트 파일 작성
90+
- `docs`: 문서에 관한 수정
91+
- `build`: Github Action, 의존성 추가 등 빌드에 관련된 작업
92+
- `chore`: 정적 파일 추가 제거 등 기타 작업
93+
94+
### Merge Stage
95+
96+
Merge는 관리자들의 코드리뷰를 통해 이뤄집니다.
97+
Pull Request의 Stage는 다음과 같습니다.
98+
99+
> 💡 해당 상태는 base브랜치가 main 일 때만 적용되는 규칙입니다.
100+
101+
#### Reviewing
102+
103+
- PR 리뷰가 진행중인 상태입니다.
104+
105+
#### Approve
106+
107+
- 모든 관리자에게 Approve 상태 일 때, 해당 상태로 변경합니다.
108+
109+
#### Resolving Merge Confilct
110+
111+
- PR이 Approve 상태이나, Merge Confilct가 해결되지 않은 상태입니다.
112+
113+
#### Ready for Merge
114+
115+
- Approve 상태이면서 Resolving Merge Confilct 상태가 해결되었을 때 나타냅니다.
116+
117+
PR은 `Ready for Merge` 상태일 때 Merge 합니다. Merge는 `Create Merge Commit`을 통해 진행하고, 이 때 커밋명은 다음과 같습니다.
118+
119+
```
120+
<type>: <PR-title> (#pr-number)
121+
```
122+
123+
**커밋명 예시**
124+
125+
```
126+
fix: 합불 상태 변경 요청 method가 올바르지 않았던 버그 수정 (#222)
127+
feat: 합/불 상태관리 페이지 추가 (#205)
128+
```
129+
130+
## Release Note
131+
132+
우리는 운영환경에 배포될 때, Release note를 작성합니다. 그 이유는 임의의 버전을 검증한 이후에 운영환경에 올리기 때문입니다.
133+
134+
따라서, main에 merge가 되었다고 배포가 되는 것이 아닌, 내부 논의를 통해서 운영 배포 커밋을 결정합니다.
135+
136+
이를 통해 배포를 하였다면, 배포된 커밋에 릴리즈 노트를 작성해야 합니다.
137+
138+
### Semantic Versioning
139+
140+
먼저, 우리는 유의적 버저닝을 통해 버전을 관리합니다.
141+
아래는 간단한 버저닝 기준을 나타냅니다.
142+
143+
#### Major Version(주)
144+
145+
- 신입모집 프로세스의 변경
146+
- 프레임워크의 변경
147+
148+
#### Minor Version(부)
149+
150+
- 기존에 없던 신규 페이지 생성
151+
- 라이브러리 버전 업으로 인해 하위호환성을 유지할 수 없는 상황
152+
- 프로젝트 구조의 큰 변경
153+
154+
#### Patch Version(수)
155+
156+
- 간단한 버그, 오타 수정
157+
- 기존 페이지 내에서 API 수정 및 추가
158+
159+
\*\* 문서 수정 커밋은 버저닝 태그가 될 수 없습니다. 다음 배포 릴리즈 태그에 포함시켜주세요.

0 commit comments

Comments
 (0)