Repository 구성에 대한 규칙서

Repository 명명 규칙

1. 다음과 같은 규칙으로 Repository 이름을 선정한다.

[prefix]-[project name]

ex) toy-dinogame
ex) proj-flamebase

이때, [project-name]에는 ' ' 문자가 포함되어서는 안된다.

2. [prefix]에 대해서는 다음과 같이 한다.

• proj 현재 개발 중이거나 서비스 중인 프로젝트의 Repository
• toy toy project의 Repository
• docs 규칙이나 설명서 혹은 실질적으로 작성하는 코드 없이 문서가 주를 이루는 Repository
• depr Deprecated 된 모든 종류의 Repository

Repository의 기술 스택 선정 규칙

1. 일반적으로 Repository의 기술 스택 선정에는 다음과 같은 규칙을 따른다.

• c/c++ make low level, CLI 혹은 고성능 서버의 경우
• markdown markmold 문서가 주를 이루는 경우
• markdown toml treepot
  • 정적 사이트
  • deployment와 rerendering 주기가 일치하는 웹사이트의 경우
• scss CSS 프레임워크
• next.ts
  • SEO가 요구되는 사이트
  • business logic의 상당 부분이 서버에서 처리되어야 하는 경우
• vite typescript
  • SEO가 요구되지 않는 web-app
  • 서버에서 처리되는 business logic이 부차적이거나 적은 경우
  • PWA를 목표로 하는 경우
• clojure (ring)
  • 상용 프로젝트
  • 일반적인 목적의 서버
  • REST 서버

2. 위 규칙에 대해, 예외적으로 다른 기술 스택을 사용해야 하는 경우, 관리자와 의논한다.

블로그 작성 규칙

1. githubname/postname로 branching
2. common markdown을 준수하여 글 작성
3. branch를 push 및 관리자에게 연락

이때, postname은 영어 소문자와 -만을 허용

Python 관련 규칙

사용 금지

Zen

1. only one rule is enough
2. beautiful than fast
3. statuc than dynamic
4. compile than interpret
5. if needed, catch that old-school
6. if needed, be quick and dirty
7. avoid a blue snake
8. avoid Evail-Creating Mature-Away script
9. aviud Tragedy of Magic Programming
10. avoid ConsoleServiceAbstractFactoryImpl