컨트리뷰션 가이드

정의 및 개요

컨트리뷰션 (Contribution: 기여)은 오픈소스 프로젝트에 참여하고 기여하는 모든 활동을 의미한다. 오소리 프로젝트 역시 다양한 컨트리뷰션 활동을 통해 데이터를 발전시키고자 하는 목적이 있다.

이 가이드는 오소리 프로젝트에 기여자(Contributor)로서 참여하는 방법을 설명하고 있다.

준비

오소리 프로젝트에 컨트리뷰션 하기 위해서는 오소리 프로젝트 가입 신청서를 제출해야 하고, 컨트리뷰션 가이드의 행동지침(기여 방법과 형식)을 따라야 한다. 오소리 프로젝트 가입 신청서에는 컨트리뷰션을 하기 위해 필수적으로 동의해야 하는 항목이 존재하는데, 컨트리뷰션 전 반드시 내용을 숙지하고 있어야 한다. 오소리 프로젝트 가입 신청서 작성 및 가입 동의는 회원가입 시에 진행되므로 컨트리뷰션을 진행할 계획이 있다면 내용을 확인하는 것이 필요하다.

신청서에 대한 자세한 내용은, 해당 문서 (다운로드 링크: 개인, 기업) 에서 확인할 수 있다.

유형

오소리 프로젝트에 참여할 수 있는 방법은 다양하다. 오소리 프로젝트에 존재하는 오타 정정부터 존재하지 않는 데이터를 추가하는 것까지 폭 넓은 컨트리뷰션이 가능하다. 모든 컨트리뷰션은 오소리 위원회에서 데이터의 무결성을 확인한 후, 반영 여부를 결정하여 working day 기준 30일 이내 조치될 것이다. 모든 컨트리뷰션은 오소리 프로젝트 깃허브 를 통하여 진행된다. 데이터 추가/수정, 버그리포트, 의견 및 기능 제안에 대한 컨트리뷰션은 깃허브 Issue를 생성해서, 번역은 PR 을 생성하여 리뷰 요청이 가능하다.

오소리 프로젝트에 어떤 유형의 컨트리뷰션이 있는지 또한 어떻게 참여할 수 있는지에 대해서는 아래에 기술되어 있다.

데이터 추가/수정

오소리 프로젝트에 신규로 추가하고 싶은 오픈소스와 라이선스 정보가 있거나, 기존 데이터에서 수정을 요청할 때 아래와 같이 진행한다.

  1. 오소리 프로젝트 깃허브의 Issue 탭에서 [New Issue] 선택
  2. 이슈 종류 중 데이터 추가/수정 [Get Started] 선택
  3. 오픈소스 명칭, 라이선스, 버전, 다운로드 저장소 주소 필수 입력
  4. 필요에 따라 부가설명을 Description 에 작성 (ex. 데이터 수정을 요청하는 오류 내용 작성)
  5. 형식에 맞게 작성 후에 [Submit new issue] 선택

버그 리포트 (오타 수정 포함)

오소리 프로젝트에 참여하면서 발생한 버그를 이슈로 올릴 수 있다.

  1. 오소리 프로젝트 깃허브의 Issue 탭에서 [New Issue] 선택
  2. 이슈 종류 중 버그리포트 [Get Started] 선택
  3. 버그 설명, 버그 재현 과정, 기대 되는 동작 등 형식에 맞게 작성 후에 [Submit new issue] 선택

의견 및 기능 제안

오소리 프로젝트 사용에 대해 기능 관련 개선점이 필요하다면 의견을 제시할 수 있다.

  1. 오소리 프로젝트 깃허브의 Issue 탭에서 [New Issue] 선택
  2. 이슈 종류 중 의견 및 기능 제안 [Get Started] 선택
  3. 자유로운 의견을 Description 항목에 작성 후에 [Submit new issue] 선택

번역 하기

오소리 프로젝트는 한글과 영문 버전으로 서비스를 제공하고 있다. 오소리의 사용성 확대 및 편의성을 위해 이외의 언어로 변역하는 컨트리뷰션은 언제나 환영한다. 번역을 완료한 패치에 대해서는 PR을 생성하여 리뷰 요청을 한다.

문의하기