그누빌의 GitHub Organization은 동아리원들이 함께 배우고, 만들고, 결과물을 공유하기 위한 공간입니다. 개발 경험이 없어도 환영합니다. 질문, 문서 개선, 작은 코드 수정도 좋은 기여입니다.
이 문서는 Organization의 기본 가이드입니다. 프로젝트별 README나 CONTRIBUTING 문서가 있다면 해당 프로젝트의 안내를 우선해 주세요.
- 프로젝트의
README.md를 읽고 개발 환경과 목표를 확인합니다. - 하고 싶은 작업이 있다면 담당자와 이야기하거나 Issue로 제안합니다.
- 가능하면 별도 브랜치에서 작업합니다. (예:
feat/login,docs/setup-guide) - 변경 내용을 이해하기 쉬운 커밋 메시지로 남깁니다.
- 다른 사람이 함께 검토할 수 있도록 Pull Request(PR)를 열고, 무엇을 왜 바꿨는지 간단히 적습니다.
소규모 스터디나 실습에서는 팀이 합의한 더 간단한 방식으로 진행해도 괜찮습니다.
- 처음 보는 사람도 따라 할 수 있도록 실행 방법과 필요한 준비물을 README에 남겨 주세요.
- 오류를 발견하면 재현 방법, 기대한 결과, 실제 결과를 가능하면 함께 공유해 주세요.
- 남의 작업을 수정할 때는 변경 이유를 설명하고 서로 존중하며 의견을 나눠 주세요.
- 이미 공개된 외부 코드를 가져올 때는 원저작자의 라이선스와 출처를 확인해 주세요.
- 비밀번호, API 키, 토큰, 개인키, 인증서 등 비밀정보를 커밋하지 마세요. 필요한 설정값은
.env.example처럼 예시 파일로 안내하고, 실제 비밀정보는 안전하게 별도 관리해 주세요. - 학번, 전화번호 등 동아리원이나 제3자의 개인정보를 동의 없이 올리지 마세요.
- 서버의 관리자 접속 정보, 내부 구성 자료 등 비공개 운영 정보는 공개 저장소에 올리지 마세요.
- 실수로 비밀정보를 커밋했다면 파일 삭제만으로 끝내지 말고 즉시 담당자에게 알리고 해당 인증정보를 폐기·재발급해 주세요.
막히는 부분이 있다면 혼자 해결해야 한다고 생각하지 않아도 됩니다. 해당 프로젝트의 Issue 또는 동아리 내 소통 채널을 통해 편하게 질문해 주세요.
만들고, 나누고, 함께 자란다.