Coding Convention

CB-TB 소스코드 수정 시 준수하면 좋은 코딩 규칙(convention)

CB-TB는 개발 중인 프로젝트로, 아직 미성숙한 코드들이 있습니다.

아래의 코딩 규칙을 따라 개선해가고자 합니다. (기여 환경!!)

신규 코드에 대해서도 가급적 아래의 규칙에 따라 기여해주시길 부탁 드립니다.

(해당 가이드는 논의에 따라 수정될 수 있습니다.)

1. Go

1.1 기본 사항 (가급적 준수)

• Go Code Review Comments
• Effective Go
• Godoc: documenting Go code

1.2 상세 사항 (가급적 준수)

• 변수명 및 함수명은 camelCase 의 규칙을 따른다. (가급적 underscore _ 를 사용하지 않는다)
• Gofmt 를 통해 소스코드 정렬을 자동화 한다.
• 코드 및 주석은 영문으로 작성한다.

2. Bash (script)

2.1 기본 사항 (가급적 준수)

• Shell Style Guide

1.2 상세 사항 (가급적 준수)

• 코드 및 주석은 영문으로 작성한다.

ETC