opgginc / styleguide

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

OP.GG Style Guides

OP.GG 의 모든 프로젝트는 각자 개별적인 디자인 스타일들을 가지고 있습니다. 하지만 이를 최대한 통일한다면 좀 더 코드 관리나 접근에 대해서 유연해질 수 있습니다. 진입장벽을 허무는 것이죠. 그동안은 의미 있는 컨벤션이 사내에 존재하지 않았지만 점차 컨벤션(Best Practice)을 정해나가려고 합니다. 그리고 많은 피드백을 통한 개선을 위해 이 문서를 오픈소스로 공개합니다.

이곳에서 "Style"이라 함은 꽤 많은 의미를 내포합니다. "Class 의 메소드에서는 camelCase 로 네이밍 하세요" 부터 시작해서, "하드코딩을 하지마세요"나 "코드 삭제를 두려워하지 마세요"와 같은 철학적인 이야기, 그리고 "메소드 파라미터를 너무 늘리지 말고 Factory 패턴의 메소드를 개발하세요" 까지, 여러가지 코딩에 대한 이야기를 포함합니다.

이 프로젝트는 OP.GG 에서 관리하고 있습니다. 하지만 개선이나 의견은 항상 환영하며 Pull-Request 를 해주신다면 적극적인 검토 후 프로젝트에 반영할 수 있도록 하겠습니다. 또한 Fork 나 Clone 후 직접 사용도 자유롭게 하실 수 있습니다.

현재는 아래의 문서만이 관리되고 있습니다. 계속 늘려나갈 예정입니다.

About

License:MIT License