Skip to content

Commit

Permalink
Add rules and descriptions for collaboration (#8)
Browse files Browse the repository at this point in the history
* modify README.md [#1]

* add rules and descriptions
  • Loading branch information
DokySp authored Aug 14, 2024
1 parent 0e7239c commit cadaaee
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .github/issue_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[Descriptions]
-
3 changes: 3 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[Issue] #
[Descriptions]
-
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,35 @@
# 같이네컷
- Last updated: 2024-08-13

## Specification

### Android
- targetSdk 35
- minSdk 31
- DataBinding
- targetSdk `35`
- minSdk `31`
- DataBinding for UI
- Clean Architecture based

### Contributor
- Dokyoon Kim (DokySp)
- Yoonsoo Kim (ing03201)

## How to work with others
1. `Issues`에 새로운 이슈를 생성한다.
- Assignee: 실제 작업하는 사람
- Labels: 해당하는 라벨 추가 **반드시 하나의 라벨만 추가할 것**
- Projects: `FourCutsTogether - Android`
- Milestone: 첫 버전 배포 전까지 `Phase 1` 사용
2. 코드 작업 후, PR 및 리뷰를 요청한다.
- 자세한 내용은 아래 `PR Rules`를 따른다

## PR Rules
- `main` branch 만을 두고 개발한다.
- 타인의 리뷰를 받기 전 merge는 금지된다.
- build pass 이전에 merge는 금지된다.
- PR 요청 시, **Description에 위에서 생성한 Issue number를 반드시 기입한다.**
- PR 요청 시, 아래 속성을 채운다.
- Reviewers: 자신을 제외한 모든 사람
- Assignee: 자신
- Labels: 해당하는 라벨 추가 **반드시 하나의 라벨만 추가할 것**
- Projects: 기입 X
- Milestone: 기입 X

0 comments on commit cadaaee

Please sign in to comment.