BeMe

나를 알아가는 질문, 나를 돌아보는 시간 BeMe

Project Archived (2021.01 ~ 2022.06)

나는 어떻게 살고 싶은 지, 무엇을 중요하게 생각하는 지
어떤 사람과 함께하고 싶고, 삶을 어떻게 마무리하고 싶은 지
"나"답게 살고 싶다는 생각을 하지만 정작 '나'를 알아간다는 건 쉽지 않습니다.
그러나, BeMe를 사용하는 여러분들은 매일 제공되는 질문들로 자신을 성찰하고 알아가게 되는 경험을 느낄 수 있을 것입니다.

BeMeRoid, ✨ Thanks to your contributions! ✨

이현우	손연주	김우빈	이세민

BeMe's Coding Convention

Kotlin Style Guide

BeMe는 Google의 Kotlin Coding Style Guide를 따릅니다

Class Layout

다음과 같은 순서 클래스를 구성합니다

• Property 선언과 초기화 블럭(intializer blocks)
• 추가적인 생성자
• 메소드 정의
• 컴패니언 오브젝트(Companion object)

Naming Rule

Package

• 패키지의 이름은 항상 소문자로 하고, 밑줄을 사용하지 않습니다
• 두 개 이상의 단어를 한 번에 사용하는 것을 지양합니다

Class/Object

• Pascal Case

class BeMe
open class BeMeParent { /* ... */ }
object MoreSampleName : SampleName() { /* ... */ }

Function/Parameter/Variable

• Camel Case

val initList = mutableList<BeMeData>()
fun getList: List<BeMeData>() { /* ... */ }

Constant

• Upper Snake Case
• 상수는 companion objet에 넣어 보관합니다

companion object {
    const val MAX_COUNT = 8
}

Formatting

Indenting

Tab 키를 써서 Indenting 합니다

중괄호

괄호 뒤에 한 칸을 띄우고 사용합니다

if (elements != null) {
    for (element in elements) {
        // ...
    }
}

괄호

• Control문(if/while/for)
  • 한 칸 띄어씁니다
• 생성자/Method
  • 붙여씁니다

if (isSpacing == true) { /*...*/ }
fun isSpacing() { /*...*/ }

Colon(:)

• 변수의 타입/함수 리턴 타입 결정
  • 콜론을 앞에 붙인다
• 상속받은 클래스/인터페이스 구분
  • 한 칸 띄어쓴다

fun isSpacing(): Boolean { /*...*/ }
class MainActivity : AppCompatActivity()

BeMe's Git Commit Message Convention

Base Structure

#{issue_number} [TYPE] : subject

body(optional)

footer(optional)

Issue Number

• BeMe는 이슈 단위 커밋으로 기능 개발을 관리합니다
• GitHub에서 이슈를 트래킹을 할 수 있게 Issue Number를 커밋 메시지에 넣어줍니다

TYPE

• FEAT: 새로운 기능 개발
• FIX: 버그 수정
• DOCS: 문서 수정/추가
• STYLE: 스타일(xml file) 코드 변경
• REFACTOR: 리팩토링
• TEST: 테스트 코드 추가/테스트 리팩토링(Room, Retrofit 동작 확인을 위한)
• CHORE: Gradle이나 설정 세팅할 때

Subject

• Subject는 50글자를 넘어가면 안된다
• 첫 시작은 대문자로 해야한다
• 마지막에 마침표(.)를 찍으면 안된다
• 어떤 변경점이 있는지 설명한다
• 명령조를 사용한다

Body

• 부연 설명이나 커밋의 이유를 설명할 때만 사용
• Not How, Explauin What and Why
• 윗 부분과 1줄의 공백 필요
• 각 라인은 72자 초과 불가

Footer

• Issue Tracker IDs를 적을 때 사용

BeMe's Git Branch Strategy: Git-Flow

Tech Spec

• App Architecture based on Android App Architecture