ContributorGuide.md

Contributor guide

Dokkaebi에 기여

이 문서는 도움을 구하거나 버그를 보고하거나 프로젝트에 기여하려는 분들을 위한 문서입니다.

다양한 분야에서 재능을 가지신분들의 멋진 참여를 기대합니다 가이드를 참고 해주세요

시작하기전

Dokkaebi에 관한 모든 작업은 GitHub을 통해 소통 합니다.

시작하기 전에 커뮤니티 규정인 행동강령을 확인 후 지켜주세요

우리는 Bug에 대해 GitHub Issue를 사용하고 있습니다.

새 Bug를 이야기 하기전 이미 논의되고 있는 Bug는 아닌지 확인해주세요

개발 가이드

버전 정보

Dokkaebi는 원할한 개발을 위해 개발환경의 통일성을 준수합니다.

아래와 같은 개발 환경 준수를 부탁드립니다.

기술 스택

Back-end
Front-end

시작하기

Dokkaebi는 코드의 통일성 및 원활한 가독성, 유지보수등의 이유로

Java, JavaScript , DataBase ,Git 에서 스타일 가이드를 제공합니다.

• Java, JavaScript , DB의 Style Guide 및 이 이 문서에서 확인 해주세요
• Git과 관련된 brach, commit, merge 등의 규칙은 이 문서에서 확인 해주세요

Issues를 보고하려면?

[Git Issue]자유롭게 문제를 제출 하세요. GitHub bug 템플릿을 준수하고 다음을 포함하는지 확인하세요.

1. 버그 요약
2. 버그 재현을 위한 단계
3. 버그가 발생한 Dokkaebi 버전
4. 버그가 발생한 Dokkaebi 구성 또는 서비스 구성