CONTRIBUTING.md

Contributing Guide

소만사 오픈소스 프로젝트에는 누구나 기여자가 될 수 있습니다.

커뮤니케이션 채널

프로젝트에 대한 공지사항이나 이슈 문의는 아래 커뮤케이션 채널을 통해 진행됩니다.

• Slack 채널 가입 링크
• Google Groups: sjinlee@somansa.com 으로 메일 주시면 초대장을 보내드립니다.

버그 리포팅 방법

GitHub의 Issue 를 이용하여 프로젝트에서 발견된 버그를 리포팅 할 수 있습니다. 리포팅 시에는 다음의 내용이 포함되어야 합니다.

• 버그 요약
• 재현 방법(가능한 구체적으로)
• 예상 결과 및 실제 현상
• 기타 참고 사항

Pull Request 체크리스트

Pull Request를 보내기 전에, 다음의 체크리스트가 충족되었는지 확인 해야합니다.

• 프로젝트의 기여하기 가이드라인 읽기
• Code of Conduct 읽기
• 기여자 라이선스 동의서(CLA, Contributor License Agreement)를 읽고 동의하기
• 소만사 코딩 가이드라인 읽기

Pull Request 시작하기

1. 'Fork'를 통해 원본 Repository를 나의 Repository로 가져옵니다.
2. 'Clone'을 통해 내 Repository를 로컬 저장소로 가져옵니다.
3. 로컬에서 작업한 결과를 'Commit'하고, 'Push'를 통해 나의 Repository에 업로드 합니다.
4. 'Pull Request'를 통해 나의 작업 내용을 원본 Repository에 반영 요청합니다.

소만사 코딩 가이드라인(C 언어) - Naming Rules

1. 일반

• 함수 이름, 변수 이름, 파일 이름은 약어를 사용하지 않고 서술형으로 작성합니다.

2. 파일 이름

• 파일 이름의 첫글자와 단어의 시작은 대문자로 구성합니.
• 이미 존재하는 파일 이름은 사용하지 않습니다.
• 파일 이름은 되도록 상세하게 짓습니다.
• 인라인 함수는 헤더 파일에 정의합니다.

3. 디렉터리 이름

• 디렉터리 이름의 첫글자와 단어의 시작은 대문자로 구성합니다.

4. 타입 이름

• 타입 이름은 언더바('_')로 시작하며, 모두 대문자로 구성합니다.

5. 변수 이름

• 변수 이름의 첫글자와 단어의 시작은 대문자로 구성합니다.
• 전역변수는 'g_'와 같이 구분가능한 접두어를 사용합니다.

6. 상수 이름

• 상수 이름은 k로 시작하고, 대소문자가 섞인 형태를 사용합니다.

7. 함수 이름

• 함수 이름은 대문자로 시작하고 각 단어의 첫글자를 대문자로 쓰며, 언더바는 사용하지 않습니다.