README.md

RIDI Style Guide

규칙을 정하는 규칙 (메타 규칙)

1. 항목의 수를 최소화할 것

• 반드시 지켜져야 하는 것 위주로 정할 것
• 권장 항목은 규칙에 포함하지 말 것

2. 올바름을 추구할 것

• 쉽지만 잘못된 것보다는 어렵더라도 올바른 쪽을 택할 것

3. 기호의 충돌이 발생했을 때에는 간결한 쪽을 택할 것

• 간결함이 동일할 때에는 일관성이 있는 쪽을 택할 것
• 일관성이 동일할 때에는 대중성이 있는 쪽을 택할 것

4. 만장일치로 진행할 것

• 이해관계에 포함된 팀 리더들 전원의 동의를 구할 것

Communication

• 코드 리뷰 원칙
• 코드를 공개하기
• 슬랙 사용 규칙
• HTTP API 작성 가이드

Language

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

Platform

• Android - Kotlin, Java, XML 코딩 스타일
• iOS - Swift, Objective-C 코딩 스타일
• Qt - C++, XML 코딩 스타일
• CMS - 내부 시스템 개발 가이드

Frameworks

• Luigi
• Spark