+Git Workflow
-
+
```
1. local - feature에서 각자 기능 작업
@@ -166,38 +173,37 @@ iOS의 Share Extension, Android의 Intent Filter를 사용하여 홈 화면으
3. 이후 remote - develop 으로 PR
4. 코드 리뷰 후 Confirm 받고 Merge
5. remote - develop 에 Merge 될 때 마다 모든 팀원 remote - develop pull 받아 최신 상태 유지
- ```
+```
-
-| Branch Name | 설명 |
-| :---: | :-----: |
-| main | 초기 세팅 존재 |
-| develop | 로컬 develop merge 브랜치 |
-| philip | 효식 로컬 develop 브랜치 |
-| jobchae | 정아 로컬 develop 브랜치 |
-| localdevelop_#issue | 각자 기능 추가 브랜치 |
+| Branch Name | 설명 |
+| :------------------: | :-----------------------: |
+| main | 초기 세팅 존재 |
+| develop | 로컬 develop merge 브랜치 |
+| philip | 효식 로컬 develop 브랜치 |
+| jobchae | 정아 로컬 develop 브랜치 |
+| localdevelop\_#issue | 각자 기능 추가 브랜치 |
### 📌 Commit Convention
-##### [TAG] 메시지
+##### [TAG] 메시지
-| 태그 이름 | 설명 |
-| :--------: | :----------------------------------------------------------: |
-| [CHORE] | 코드 수정, 내부 파일 수정 |
-| [FEAT] | 새로운 기능 구현 |
+| 태그 이름 | 설명 |
+| :--------: | :---------------------------------------------------------------: |
+| [CHORE] | 코드 수정, 내부 파일 수정 |
+| [FEAT] | 새로운 기능 구현 |
| [ADD] | FEAT 이외의 부수적인 코드 추가, 라이브러리 추가, 새로운 파일 생성 |
-| [HOTFIX] | issue나 QA에서 급한 버그 수정에 사용 |
-| [FIX] | 버그, 오류 해결 |
-| [DEL] | 쓸모 없는 코드 삭제 |
-| [DOCS] | README나 WIKI 등의 문서 개정 |
-| [CORRECT] | 주로 문법의 오류나 타입의 변경, 이름 변경에 사용 |
-| [MOVE] | 프로젝트 내 파일이나 코드의 이동 |
-| [RENAME] | 파일 이름 변경이 있을 때 사용 |
-| [IMPROVE] | 향상이 있을 때 사용 |
-| [REFACTOR] | 전면 수정이 있을 때 사용 |
+| [HOTFIX] | issue나 QA에서 급한 버그 수정에 사용 |
+| [FIX] | 버그, 오류 해결 |
+| [DEL] | 쓸모 없는 코드 삭제 |
+| [DOCS] | README나 WIKI 등의 문서 개정 |
+| [CORRECT] | 주로 문법의 오류나 타입의 변경, 이름 변경에 사용 |
+| [MOVE] | 프로젝트 내 파일이나 코드의 이동 |
+| [RENAME] | 파일 이름 변경이 있을 때 사용 |
+| [IMPROVE] | 향상이 있을 때 사용 |
+| [REFACTOR] | 전면 수정이 있을 때 사용 |
### 📌 Coding Convention
@@ -220,77 +226,86 @@ iOS의 Share Extension, Android의 Intent Filter를 사용하여 홈 화면으
주석
-
+
+
+1. 한줄 주석은 // 를 사용한다.
+
+```javascript
+// 한줄 주석일 때
+/**
+ * 여러줄
+ * 주석일 때
+ */
+```
+
+2. 함수에 대한 주석
+
+```javascript
+ /**
+ * api get /travel/:groupNumber
+ * 그룹 여행 정보 가져오기
+```
+
+3. Bracket 사용 시 내부에 주석을 작성한다.
+
+```javascript
+if (a === 5) {
+ // 주석
+}
+```
- 1. 한줄 주석은 // 를 사용한다.
- ```javascript
- // 한줄 주석일 때
- /**
- * 여러줄
- * 주석일 때
- */
- ```
- 2. 함수에 대한 주석
- ```javascript
- /**
- * api get /travel/:groupNumber
- * 그룹 여행 정보 가져오기
- ```
- 3. Bracket 사용 시 내부에 주석을 작성한다.
- ```javascript
- if (a === 5) {
- // 주석
- }
- ```
-
Bracket
-
+
+
+1. 한줄 if 문은 여러 줄로 작성한다.
+
+```javascript
+// 한줄 if 문 - 여러 줄로 작성
+if (trigger) {
+ return;
+}
+```
+
+2. 괄호는 한칸 띄우고 사용한다.
+
+```javascript
+// 괄호 사용 한칸 띄우고 사용한다.
+if (left === true) {
+ return;
+}
+```
+
+3. Bracket 양쪽 사이를 띄어서 사용한다.
+
+```javascript
+// 띄어쓰기
+if (a === 5) {
+ // 양쪽 사이로 띄어쓰기
+ return;
+}
+```
- 1. 한줄 if 문은 여러 줄로 작성한다.
-
- ``` javascript
- // 한줄 if 문 - 여러 줄로 작성
- if(trigger) {
- return;
- }
- ```
- 2. 괄호는 한칸 띄우고 사용한다.
-
- ``` javascript
- // 괄호 사용 한칸 띄우고 사용한다.
- if (left === true) {
- return;
- }
- ```
- 3. Bracket 양쪽 사이를 띄어서 사용한다.
- ``` javascript
- // 띄어쓰기
- if (a === 5) { // 양쪽 사이로 띄어쓰기
- return;
- }
- ```
-
비동기 함수의 사용
-
+
|
|
-|[HYOSITIVE](https://github.com/HYOSITIVE)|[jokj624](https://github.com/jokj624)|
+### 👩🏻💻 Developers
+| 주효식 | 채정아 |
+| :----------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------: |
+| | |
+| [HYOSITIVE](https://github.com/HYOSITIVE) | [jokj624](https://github.com/jokj624) |
+
+1. async, await 함수 사용을 지향한다.
+2. Promise 사용은 지양한다.
+3. 다만 로직을 짜는 데 있어 promise를 불가피하게 사용할 경우, 주석으로 표시하고 commit에 그 이유를 작성한다.
- 1. async, await 함수 사용을 지향한다.
- 2. Promise 사용은 지양한다.
- 3. 다만 로직을 짜는 데 있어 promise를 불가피하게 사용할 경우, 주석으로 표시하고 commit에 그 이유를 작성한다.
-
-### 👩🏻💻 Developers
-| 주효식 | 채정아 |
-| :---: | :---: |
-|||
-|[HYOSITIVE](https://github.com/HYOSITIVE)|[jokj624](https://github.com/jokj624)|
+### 👩🏻💻 Developers
+| 주효식 | 채정아 |
+| :----------------------------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------: |
+| | |
+| [HYOSITIVE](https://github.com/HYOSITIVE) | [jokj624](https://github.com/jokj624) |