Skip to content

Commit ab15520

Browse files
authored
Update CONTRIBUTING.md
1 parent f753a01 commit ab15520

File tree

1 file changed

+56
-46
lines changed

1 file changed

+56
-46
lines changed

CONTRIBUTING.md

+56-46
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,82 @@
11
# Co-Labor 기여 가이드라인
22

3-
[English Version](https://github.com/Co-Labor-Project/Co-Labor-FE/blob/main/CONTRIBUTING-EN.md)
3+
[English Version](https://github.com/Co-Labor-Project/Co-Labor-BE/blob/develop/CONTRIBUTING-EN.md)
44

5-
Co-Labor 프로젝트에 관심을 가져 주셔서 감사합니다! 이 문서는 프로젝트에 기여하기 위한 지침을 제공합니다. 오픈 소스로 프로젝트를 성장시키는 데 많은 도움을 주시기 바랍니다.
5+
Co-Labor 프로젝트에 관심을 가져 주셔서 감사합니다! 🎉
66

7-
## 📌 기여 전 준비 사항
7+
<br />
88

9-
기여하기 전에 각 리포지토리의 README 파일을 참고하여 로컬 환경 설정과 필요한 종속성 설치 방법을 확인하세요.
9+
## 📌 Introduction
1010

11-
- [프론트엔드 리포지토리 README](https://github.com/Co-Labor-Project/Co-Labor-FE/blob/main/README.md)
11+
- ISSUE를 확인하여 이미 보고된 문제인지, 논의된 기능인지 확인해주세요.
12+
13+
- 새로운 기능을 제안하고 싶거나 버그를 제보하고 싶다면, 이슈를 생성해주세요.
14+
15+
<br />
16+
17+
## Configuration
18+
19+
먼저 아래의 글들을 참조하여 개발 환경을 세팅하고, 기여를 준비해주세요!
20+
21+
- [Backend](https://github.com/Co-Labor-Project/Co-Labor-BE/blob/develop/README.md)
22+
- [Frontend](https://github.com/Co-Labor-Project/Co-Labor-FE/blob/main/README.ko.md)
1223
- [QuickStart](https://github.com/Co-Labor-Project/deploy/blob/main/README.md)
1324

14-
## 🛠️ 기여할 수 있는 영역 (수정 필요)
25+
<br />
1526

16-
- **프론트엔드 기능 개선**: 사용자 경험을 향상시키기 위해 새로운 UI 기능을 추가하거나, 사용자 피드백에 따른 기능을 개선할 수 있습니다.
17-
- **UI/UX 디자인 개선**: React와 CSS를 사용해 페이지 레이아웃, 스타일, 접근성, 모바일 친화적인 반응형 디자인을 개선하여 사용자 경험을 최적화할 수 있습니다.
18-
- **버그 리포트 및 수정**: 프로젝트의 버그를 찾아 이슈를 생성하거나 직접 수정할 수 있습니다.
19-
- **문서 개선**: README나 기타 문서를 보완하여 사용성과 이해도를 높이는 데 기여할 수 있습니다.
27+
## 🛠️ How to Contirbute
2028

21-
## 📝 이슈 작성 가이드
29+
1. 이슈 생성
2230

23-
새로운 기능 개발이나 버그 수정을 위한 Issue를 작성할 때는 아래의 지침을 참고하여 자유롭게 작성해 주세요.
24-
**현재 프로젝트에 자동 이슈 템플릿 설정이 없으므로** 다음 항목을 참고하여 필요한 내용을 직접 이슈에 작성해 주세요.
31+
- Contribute를 원하는 부분에 대해 이슈를 생성해주세요.
2532

26-
### 프론트엔드 이슈 작성 지침
33+
2. 브랜치 생성
2734

28-
프론트엔드와 관련된 기능 개선이나 버그 수정을 위해 Issue를 작성할 때는 다음 항목을 참고하세요:
35+
- 생성된 이슈 번호에 맞게 브랜치를 생성해주세요.
36+
- 브랜치 네이밍 규칙: `feat/#이슈번호` 또는 `fix/#이슈번호`
2937

30-
1. **문제 설명 📘**: 발생한 문제나 개선이 필요한 기능에 대해 간결하고 명확한 설명을 작성합니다.
31-
2. **개선 또는 구현 아이디어 🛠**: 문제를 해결하거나 개선할 수 있는 방법을 간략하게 제안합니다.
32-
3. **추가 정보 📎**: 필요한 경우, 관련된 화면 캡처, 오류 메시지 등 추가 자료를 첨부합니다.
38+
3. 코드 변경
3339

34-
## 🚀 브랜치 및 Pull Request 작성 가이드
40+
- 가독성과 패키지, 파일 이름을 잘 지켜주세요.
41+
- 특히 변수와 클래스는 Camel 규칙으로 네이밍해주세요.
42+
- 주석을 상세하게 달아주세요.
3543

36-
1. **브랜치 생성**: Issue 번호를 반영한 브랜치 이름으로 새로운 기능 개발을 시작합니다.
44+
4. 커밋
3745

38-
- 브랜치 네이밍 규칙: `feat/#이슈번호` 또는 `fix/#이슈번호`
39-
- 예: `feat/#69` 또는 `fix/#45`
46+
- 컨벤션을 잘 지켜서 커밋 메시지를 작성해주세요.
47+
```
48+
feat: 새로운 기능에 대한 커밋
49+
fix: 버그 수정에 대한 커밋
50+
build: 빌드 관련 파일 수정 / 모듈 설치 또는 삭제에 대한 커밋
51+
chore: 그 외 자잘한 수정에 대한 커밋
52+
ci: CI 관련 설정 수정에 대한 커밋
53+
docs: 문서 수정에 대한 커밋
54+
style: 코드 스타일 혹은 포맷 등에 관한 커밋
55+
refactor: 코드 리팩토링에 대한 커밋
56+
test: 테스트 코드 수정에 대한 커밋
57+
perf: 성능 개선에 대한 커밋
58+
```
4059
41-
```bash
42-
git checkout -b feat/#이슈번호
43-
```
60+
5. Pull Request 생성
4461
45-
2. **커밋 메시지 작성**: 아래의 커밋 메시지 규칙에 따라 명확하게 작성합니다.
62+
- PR 룰을 잘 지켜 생성해주세요.
63+
- PR 제목 예시: `[feat] #69 - Add search functionality`
4664
47-
- `feat`: 새로운 기능에 대한 커밋
48-
- `fix`: 버그 수정에 대한 커밋
49-
- `build`: 빌드 관련 파일 수정 / 모듈 설치 또는 삭제에 대한 커밋
50-
- `chore`: 그 외 자잘한 수정에 대한 커밋
51-
- `ci`: CI 관련 설정 수정에 대한 커밋
52-
- `docs`: 문서 수정에 대한 커밋
53-
- `style`: 코드 스타일 혹은 포맷 등에 관한 커밋
54-
- `refactor`: 코드 리팩토링에 대한 커밋
55-
- `test`: 테스트 코드 수정에 대한 커밋
56-
- `perf`: 성능 개선에 대한 커밋
65+
6. 리뷰 및 피드백
66+
- PR 생성 후 GitHub의 코멘트를 통해 팀과 협의하여 필요한 피드백을 반영합니다.
67+
- 피드백 반영이 완료되면, PR에 해당 변경 사항을 커밋하고 리뷰어에게 다시 확인 요청을 합니다.
68+
- 최종적으로 팀의 승인을 받으면, PR이 병합됩니다.
5769
58-
3. **Pull Request 생성**: PR 제목과 설명에 Issue 번호를 명시하고, 필요한 경우 기능 설명과 구현 방법을 포함합니다.
70+
<br />
5971
60-
- **PR 제목 예시**: `[feat] #69 - Add search functionality`
61-
- **PR 설명**: PR 설명에는 해당 Issue에 대한 간단한 요약, 주요 변경 사항, 구현 방식 등을 포함하여 리뷰어가 쉽게 이해할 수 있도록 작성합니다.
72+
## Pull Request Checklist
6273
63-
4. **리뷰 및 피드백**: PR 생성 후 GitHub의 코멘트를 통해 팀과 협의하여 필요한 피드백을 반영합니다.
74+
[ ] 코드 스타일 가이드를 준수했나요?
75+
[ ] 테스트를 추가했나요?
76+
[ ] 커밋 컨벤션을 잘 지켰나요?
6477
65-
- 피드백 반영이 완료되면, PR에 해당 변경 사항을 커밋하고 리뷰어에게 다시 확인 요청을 합니다.
66-
- 모든 리뷰어의 승인을 받으면, 최종적으로 PR을 병합할 수 있습니다.
67-
68-
## 🗣️ 커뮤니케이션
78+
<br />
6979
70-
기여와 관련된 논의가 필요할 때는 GitHub 이슈 및 PR의 코멘트를 통해 문의해 주세요.
80+
## License
7181
72-
감사합니다! Co-Labor 프로젝트에 많은 기여 부탁드립니다.
82+
프로젝트에 기여함으로써, 귀하는 귀하의 기여가 이 프로젝트의 라이선스 하에 공개됨에 동의합니다.

0 commit comments

Comments
 (0)