Skip to content

dogsub/Armagetdon_frontend-Hackathon-

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
Armagetdon
Armagetdon
 
 
README.md
README.md
 
 

Repository files navigation

namingRule

  • commit 규칙

    <type> : <subject>

<body>

    예시)

    Feat: 회원 가입 기능 구현

SMS, 이메일 중복확인 API 개발

    1. type

      • 태그 : 제목의 형태이며, :뒤에만 space가 있음

        type description
        Add 새로운 기능 추가
        Fix  버그 수정
        Docs  문서 추가/수정
        Refactor  코드 리펙토링
        Test  테스트 코드, 리펙토링 테스트 코드 추가
        Move 파일, 폴더 경로 변경

    2. Subject

      • 제목은 최대 50글자가 넘지 않도록 하고 마침표 및 특수기호는 사용하지 않는다

      • 영문으로 표기하는 경우 동사(원형)를 가장 앞에 두고 첫 글자는 대문자로 표기

        (과거 시제를 사용하지 않는다)

      • 제목은 개조식 구문으로 작성한다 → 완전한 서술형 문장이 아니라, 간결하고 요점적인 서술

    3. Body

      • 본문은 한 줄 당 72자 내로 작성
      • 본문 내용은 양에 구애받지 않고 최대한 상세히 작성
      • 본문 내용은 어떻게 변경했는지 보다 무엇을 변경했는지 또는 왜 변경했는지를 설명
    • Commit 하는법(중요)
      • 기본적으로 안드로이드 스튜디오가 아닌 터미널로 파일을 직접 지정해 commit작업을 수행한다.
      • 기능을 한번에 커밋하는게 아닌 작은 기능 하나하나씩 커밋 해가면서 진행한다.
      • 기능을 만들기 전에 issue란에 자신이 구현해야할 기능들을 작성한다 (네이밍 자유)
      • #~~의 숫자를 기억하고 기능을 새로 만들어 미완된 기능이나 완성된 기능을 commit시엔 branch를 기능#~~로 새로 만들어 commit 후 push 한다.
        • login#34 branch 생성 후 위의 커밋 규칙에 따라 commit→push한다
        • push전엔 누군가 pull request를 한지 확인하고, 있다면 pull request를 먼저 처리한 후
        • git pull origin main을 통해 받아온 다음에 push 를 진행한다.
        • 기능이 모두 완성었다고 판단되면 branch를 삭제한다.
      • 만약 오류나면 다시 클론 받고 새로운 branch를 생성하면 거의 해결된다..

  • 네이밍 규칙

    • 유니코드를 포함한 어떤 문자든지 사용가능

      • 단, 특수문자, 수학 기호, 화살표, 개인용 유니코드, 선 등 사용 할 수 없다.
      • 단, 숫자로 시작할 수 없다.
      • 단, 공백이 포함되면 안된다.
      • 단, 해당 코드 범위 내에서 미리 사용되는 기존 이름과 동일한 이름은 사용하지 말 것

    • 이름 읽었을 때 무슨 역할을 하는 건지 파악 가능해야 한다.

    • 명사, 동사 또는 전치사로 이루어진 단어를 연결하여 만든다.

    • 시작 단어를 제외한 모든 단어의 시작은 대문자로 하고 그 이외의 모든 문자는 소문자로 한다.

    • 반복문을 사용할 때 index or employee 대신에 i,e를 사용하기

    • 범위에 한 줄만 있어도 중괄호를 추가한다.

    • 대소문자를 구별해야한다.

      • Var와 var는 다르다.

    • 스위프트에서 미리 정한 키워드 및 데이터 타입 이름은 사용할 수 없다.

    • 접두사 규칙 : 팀이니셜 혹은 다른 은유어들이 2자를 넘지 않도록 만든다.

    • 변수명, 함수명을 지을 때 따로 정해진 규칙은 없지만 보통 "헝가리안 표기법" 지키면 좋다.

    • 이름 짓기

      • 파일명

        • 파일명의 단어 첫글자는 대문자로 한다

      • 클래스, 구조체,익스텐션, 프로토콜, 열거형 이름

        • 대문자의 명사로 시작
        • UpperCamelCase 사용
          • ex) CalendarCountClass

      • 함수, 메서드, 인스턴스 이름

        • LowerCamelCase 사용 (소문자의 동사로 시작 : countValue)
        • 함수명
          • 값의 초기화 : 접두사 init 붙인다.
          • 값의 설정 : 접두사 set 붙인다.
          • 값 얻어오기 : 접두사 get 붙인다.
          • 값 추가 : 배열 등에 값 넣을 시 접두사 push 붙인다.
          • 값 빼오기 : 배열 등에서 값 빼올 시 접두사 pop 붙인다.
          • 생성 : 접두사 create
          • 열기 : 접두사 open
          • 닫기 : 접두사 close
          • Bool 값 : 접두사 is
          • 어떤 행위를 한다 : 접두사 do
          • 입력받는다 : 접두사 input
          • 저장, 기록 : 접두사 save, write
          • 반환값이 있다, 함수가 무엇인가 나오거나 추출되어질 경우 : 접두사 get, extract, read

      • 변수, 상수 이름

        • LowerCamelCase 사용 (소문자의 명사로 시작 : myValue)
        • 변수
          • 지역변수 : 소문자의 명사로 시작
          • 전역변수 : g_ 로 시작하기
          • 루프변수
          • 리스트 : 접미사 List 붙여주기

      • 함수 만들때 규칙

        • 3번 이상 호출되지 않을 경우 함수로 만들지 않기
        • 간단한 한줄짜리 코드를 함수로 만들지 않기
        • 내부에서만 도는 함수는 fileprivate / private로 정의하기
        • 함수가 너무 길어진다면 짤라서 함수 호출 할 수 있고, 주석처리로 단위를 나눌 수 있다.
        • 전제조건으로 함수는 nil을 받지 않는다.
          • 만약 nil을 받을 경우 함수이름 orNil을 붙여준다.

      • Asset 이름

        • UpperCamelCase 사용
        • 공백은 언더스코어(_)로 대체한다.
        • 접두어에는 폴더명, 컴포넌트명, 디자인 고유명이 있다.
        • 각 접두어는 언더스코어로 구분된다.
        • 여러 접두어를 사용할 경우 ‘폴더명’, ‘컴포넌트명’, ‘디자인 고유명’ 순으로 사용한다.
        • ex) welcome_logo_large.png

      • 접두어 모음

        • 폴더명

          • main
          • 아래의 tabbar의 핵심파일명 등

        • 컴포넌트명 (HIG에서 언급하는 UI Controls, UI Bars를 짧게 표현한 것)

          • navbar
          • tabbar
          • toolbar
          • searchbar
          • bar
          • control
          • btn
          • switch
          • stepper
          • slider
          • spinner

        • 디자인 고유명 (아이콘이나 로고와 같이 디자인에서 통상적으로 쓰이는 고유명사)

          • icon (아이콘)
          • logo (로고)
          • bg (백그라운드컬러 등)
          • arrow (뒤로가기 or 이동하기 버튼)
          • home (홈 화면이나 메인화면 아이콘 등)

        • 그 외 다양한 접미어 모음 (색상이나 크기, 위치, 순번, 테마, 상태 등)

          • 색상: reader_color_black.png
          • 크기: welcome_logo_large.png
          • 위치: selection_arrow_left.png
          • 순번: customfont_tutorial_1.png
          • 테마: icon_pagination_left_d.png
          • 상태: icon_freebook_on.png

      • Color

        • 구성요소(공용으로 두루두루 사용되면 main)_특징(생략가능)_색상
          • main_light_blue
          • main_dark_gray
          • home_gray

      • font

        • 미리 지정해서 전체 적용(pretendard)

About

No description, website, or topics provided.

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • Swift 100.0%