CONTRIBUTING.md

기여하기

본 프로젝트에 관심을 가져주셔서 감사합니다! 기여하기 전에 다음 지침을 읽어주시기 바랍니다.

• 한국어와 영어가 동일한 용어는 기재하지 않습니다.
  예를 들어, pull request는 한국에서도 풀 리퀘스트 그대로 사용하므로 본 프로젝트에서는 다루지 않습니다.

• 실제로 빈번하게 사용되는 한국어 용어가 존재하는 경우에만 등재합니다.
  예를 들어, merge를 합병이라고 사용하는 경우도 있지만, 대부분 머지라고 사용하기 때문에 별도로 등재하지 않습니다.
  하지만 이는 주관적인 영역이므로, 기여자의 기여를 최대한 반영합니다.

• 기술 용어뿐만 아니라 개발자 사이에서 사용되는 은어나 슬랭 따위도 등재합니다. 단, 비하나 경멸의 의도를 가진 용어는 제외합니다.
  예를 들어, Code Monkey는 코더로 사용되나 비하의 의도로도 사용되기에 등재하지 않습니다.

• 목차로 개발 용어의 분야를 구분하고는 있으나, 절대적인 것은 아닙니다.

커밋 메시지 가이드라인

타입

타입은 커밋의 목적을 간단하게 나타냅니다. 본 프로젝트는 아래의 타입을 사용하며, 타입은 모두 소문자를 사용합니다.

• add: 새로운 단어 혹은 설명 추가
• fix: 잘못된 정보의 수정, 오타 수정
• docs: 기타 문서 작업

제목(Subject)

• 마침표는 사용하지 않습니다.

본문(Body) (선택적)

• 제목으로 충분한 설명이 불가할 때 사용합니다.
• 어떻게 변경했는지보다, 왜 변경했는지에 대해 설명합니다.

푸터(Footer) (선택적)

• 이슈 트래커 ID나 참조된 이슈에 대한 정보를 작성합니다.

예시 커밋 메시지

fix: "변수" 단어 설명 수정

변수 단어에 대한 설명에 오류가 있어 수정하였음.

Closes #123

피드백과 제안

• 프로젝트 개선을 위한 아이디어나 제안이 있으시면 언제든지 이슈를 통해 공유해주세요.
• 모든 피드백과 제안은 프로젝트에 큰 도움이 됩니다.