nolboo/style-guide

RIDI Coding Style Guide

RIDI Style Guide

Language

• HTML - HTML, Twig/Jinja2 코딩 스타일
• JavaScript
• Less - Less/CSS 코딩 스타일
• MariaDB(MySQL) - DDL, DML 작성 규칙
• PHP
• Python3

Platform

• Android - Kotlin, Java, XML 코딩 스타일
• iOS - Swift, Objective-C 코딩 스타일
• Qt - C++, XML 코딩 스타일

Etc

• 슬랙 사용 규칙
• RESTful API - RESTful API 작성 규칙
• UI 텍스트 작성 가이드

규칙을 정하는 규칙

우리의 기조는 아래와 같다. (중요한 순서대로)

1. 항목의 수를 최소화할 것
   • 반드시 지켜져야 하는 것 위주로 정할 것
   • 권장 항목은 규칙에 포함하지 말 것
2. 기호의 충돌이 발생했을 때에는 간결한 쪽을 택할 것
   • 간결함이 동일할 때에는 일관성이 있는 쪽을 택할 것
   • 일관성이 동일할 때에는 대중성이 있는 쪽을 택할 것
3. 코드의 작성자보다 리뷰어의 입장을 우선할 것
   • 불필요한 diff를 최소화 할 것
4. 개발도구 중립성을 지킬 것

코드 리뷰 원칙

• 충분히 좋아야 올바르게 리뷰한 것
• 의견보다 사실을 주장할 것
• 사실에는 출처가 따르고, 의견에는 이유가 따를 것
• 코드 중복은 2번까지 허용
• 구체적일 것
• 필요하다면 "오프라인"으로 토론하되, 해결책은 기록을 남길 것
• 코딩스타일은 지적하지 않을 것
  • 이는 Linter(Fixer)가 할 일이다.