CONTRIBUTING.md

Contribution Guide

이 프로젝트에 대한 Issue 또는 Pull Request은(는) 언제나 환영합니다.

아래는 기여자 간의 원활한 의사소통을 위한 정보와 그 외 기타 정보들이 포함되어있으니, 반드시 읽어주시기 바랍니다.

목적

이 프로젝트는 대한민국 초·중등 교육기관의 학생들을 위해 종합적인 학교 정보를 제공하는 것을 목표로 합니다. 안정적인 제공을 위해 본 프로젝트에서 사용되는 모든 API은(는) 대한민국 정부의 공공 데이터 개방 정책에 따라 공개된 공식 API만을 사용하며, 비공식적인 구현은 허용하지 않습니다.

규칙

커밋

커밋 시에는 해당 커밋에서 이루어진 주요 작업의 주제에 따라 아래의 접두사들을 사용하여 변경 내역을 알려주시기 바랍니다.

• docs
• feature
• fix

(예시)
docs: README.md is updated, OPENSOURCES.md is updated.
fix: API error is fixed.

표준

이 프로젝트는 Android Studio의 최신 버전으로 개발되며, 코딩 컨벤션은 Dart에서 지정한 표준 코딩 컨벤션을 따릅니다.

유의사항

기여자 분들은 아래와 같은 점들을 유의해주시기 바랍니다.

• Pull Request 시에는 기여 내용과 관련이 있는 브랜치에 병합을 요청해주시기 바랍니다. 만약 관련 브랜치가 없을 경우에는 Issue을(를) 통해 새로운 브랜치 생성을 요청해주세요.
• Issue 또는 Pull Request을(를) 이용한 기여가 이루어졌을 경우, 기여자는 자신이 작성한 코드를 MIT 라이센스에 의거하여 배포하는 것에 동의하였다고 간주합니다.
• 기여자가 제공한 코드는 메인테이너에 의하여 적절히 수정되어 사용됩니다.
• 기여자들이 제공한 코드는 'My School Contributors'라는 공동 명의 하에 제공됩니다.