Skip to content

dudaji/dudaji-guide

Repository files navigation

dudaji-guide

1. Dudaji style guide

  • 한줄에 80(100)자 까지만 허용합니다. 길다면 줄바꿈을 하거나 리펙토링을 하도록 합니다.
  • while, for, if 등에 의해 depth가 깊어지는 것을 싫어합니다. 가능하면 2 depth 까지가 좋고 3 depth 까지는 허용합니다. 그 이상의 depth 는 지양합니다.
  • 함수는 한페이지(40줄 정도) 이내로 작성합니다.
  • 맴버 변수는 풀네임을 꼭 이용합니다.
  • 로컬 변수이고 한 페이지(40줄 정도)의 변수 스코프인 경우라면 짧은 이름의 변수를 허용합니다.
  • 네트웍이 안되는 환경에서도 개발을 할 수 있도록 모든 것을 로컬에 띄워서 개발하는 것을 좋아합니다. 어쩔수 없는 상황이 아니라면 개발서버에 붙어서 작업하는 것도 싫어합니다.
  • 기능단위의 개발을 좋아합니다. 풀스택개발을 선호합니다. 서버/클라이언트 개발자로 나누어서 개발하는 것을 싫어합니다
  • git-flow를 사용합니다 https://danielkummer.github.io/git-flow-cheatsheet/index.ko_KR.html
  • 로직이 복잡한 경우에는 유닛테스트를 작성합니다. 로직이 단순한 경우에는 유닛테스트가 없는 것을 허용합니다.
  • 기타 스타일가이드는 python: PEP-8, javascript: airbnb style guide, etc: google style guide를 이용합니다.

2. Skeleton and terminal guide

  • 환경변수는 .env.example 등으로 제공하고 로컬에 띄우는 것 기준으로 작성합니다. 다른 작업자는 cp .env.example .env를 통해서 환경변수를 복사합니다.
  • sh/ folder에 실행 등에 관련한 스크립트를 모아놓습니다.
  • 스크립트는 프로젝트 루트 폴더에서 명령을 내립니다.
# Example
./sh/bootstrap.sh
./sh/start.sh
  • 주요 프로젝트인 경우 .bashrc에 alias를 이용하여 터미널 상에서 빠르게 이동합니다.
# in .bashrc
alias g='cd ~/work/dudaji-guilde'

3. Install dotfiles

  • 두다지 기본 dotfiles를 제공하고 있습니다. bash, git, screen의 기본 설정입니다. 서버는 동일하게 세팅하고, 개인 맥에서는 선택적으로 사용하면 됩니다.
./sh/dotfiles_install.sh

4. Jetbrain IDE guide

Quick start

  • webstorm을 설치합니다.
  • 아래 플러그인을 설치합니다.
  • dudaji-jetbrain-settings.jar, jetbrain-js-style-guide-dudaji.xml을 임포트합니다.

Plugins

  • ideavim

Custom key replace

  • caps lock to ctrl

Custom key map

  • Find in path: 'cmd+shift+f'
  • Navigate / File: 'ctrl+p'
  • Navigate / Back: 'cmd+<-'
  • Navigate / Forward: 'cmd+->'
  • Code / Folding: 'cmd+shift 9, 0, -, ='
  • Code / Comment with Line Comment: 'ctrl+/'
  • Code / Reformat code: 'cmd+shift+ctrl+f'
  • Run / debug: 'F5'
  • Run / Resume program: 'cmd+alt+r'
  • Run / Toggle breakpoint: 'F9'
  • Go to definition: 'ctrl+]'

Cheat sheet

  • 원하는 파일을 열고자 하면 ctrl+p를 이용하거나 cmd+1을 누른뒤 화살표로 원하는 파일을 오픈합니다.
  • 파일내에서 정의된 곳으로 가고 싶다면 함수 위에 커서를 놓은 뒤 ctrl+]
  • 정의를 본 뒤 아까 위치로 이동하고 싶다면 'cmd+<-'
  • 파일 내에서 그랩하고 싶다면 'shift+8'
  • 전체 파일에서 검색하고 싶다면 'shift+ctrl+f'
  • page up / down을 하고 싶다면 'ctrl+f, b'
  • 몇줄의 코드를 커맨트 처리하고 싶다면 'shift+b'후 커서로 블록 지정후 'ctrl+/'
  • 코드를 폴딩해서 보고 싶으면 'cmd+shift 9, 0, -, ='
  • undo / redo: u, ctrl+r
  • 기타 vim의 기본 이용: http://vim.wikia.com/wiki/Best_Vim_Tips

5. Work style

  • 프로젝트 막판에 널널한 것을 좋아합니다. 그래서 프로젝트 초반에 달리는 것을 좋아합니다.
  • Iteration과 working s/w를 좋아합니다. 큰 설계를 위해서 너무 많은 시간을 보내거나 일부만 작성하는 모듈 작성에 너무 많은 시간을 보내는 것을 좋아하지 않습니다.
  • 문서는 3개월 뒤에 내가 봤을 때 바로 알 수 있는 수준으로 작성합니다. 너무 디테일하거나 간단하면 좋지 않습니다.
  • s/w가 잘 작동하는지 확인하기 위한 unittest, mock, stub, dummy s/w를 만드는 것을 좋아합니다.
  • 배우는 것과 가르쳐주는 것을 좋아합니다. 범용적인 지식은 주로 좋은 링크, 논문, 책을 통해서 배우고 가르쳐주고 배우는 쪽에서 열심히 배워야 합니다. 업무에 해당하는 부분은 가르쳐주는 쪽에서 열심히 가르쳐주어야 합니다.
  • 리서치는 네이버가 아닌 구글에서 합니다. 영문으로 합니다.

6. Identity

  • Customer의 고민을 함께 해결하려고 노력합니다.
  • Learn을 좋아합니다.
  • Share를 좋아합니다.
  • Backbone을 가지고 토론하는 것을 좋아합니다.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published