https://github.com/ridi/style-guide

📘 Rules of Play @ RIDI
https://github.com/ridi/style-guide

coding-conventions style-guide

Last synced: 3 months ago
JSON representation

📘 Rules of Play @ RIDI

• Host: GitHub
• URL: https://github.com/ridi/style-guide
• Owner: ridi
• Created: 2016-10-04T14:20:23.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2020-05-13T06:03:09.000Z (over 4 years ago)
• Last Synced: 2024-05-11T23:33:18.284Z (6 months ago)
• Topics: coding-conventions, style-guide
• Language: PHP
• Homepage: https://ridi.github.io/style-guide
• Size: 292 KB
• Stars: 251
• Watchers: 40
• Forks: 28
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-list - style-guide

README

        
# RIDI Style Guide

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

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

   - 반드시 지켜져야 하는 것 위주로 정할 것

   - 권장 항목은 규칙에 포함하지 말 것

#### 2. 올바름을 추구할 것

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

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

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

   - 일관성이 동일할 때에는 대중성이 있는 쪽을 택할 것

#### 4. 만장일치로 진행할 것

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




### Communication

- [코드 리뷰 원칙](Review.md)

- [코드를 공개하기](OSS.md)

- [슬랙 사용 규칙](Slack.md)

- [HTTP API 작성 가이드](API.md)

### Language

- [HTML](HTML.md) - HTML, Twig/Jinja2 코딩 스타일

- [JavaScript](JavaScript) / [TypeScript](https://github.com/ridi/tslint-config)

- [Less](Less.md) - Less/CSS 코딩 스타일

- [BEM](BEM.md) - BEM 코딩 스타일

- [MariaDB(MySQL)](MariaDB(MySQL).md) - DDL, DML 작성 규칙

- [PHP](PHP)

- [Python3](Python)

- [Scala](Scala)

- [Shell](Shell.md)

### Platform

- [Android](Android) - Kotlin, Java, XML 코딩 스타일

- [iOS](iOS) - Swift, Objective-C 코딩 스타일

- [Qt](Qt.md) - C++, XML 코딩 스타일

- [CMS](CMS.md) - 내부 시스템 개발 가이드

### Frameworks

- [Luigi](Luigi.md)

- [Spark](Scala/Spark.md)