사양
All Contributors 목록을 사용하여 기여자를 인정방식의 예제입니다.
필수 항목
Open source projects should include the following mandatory items to support the All Contributors specification:
- 프로젝트 리포지토리 문서에서 모든 프로젝트 참여자의 목록을 포함하는 주요 사이트에있는 "기여자" 섹션
- 프로젝트 문서 중 가장 눈에 잘 띄는 사이트를 사용하기 위해서 입니다. 대부분의 경우에는 프로젝트의 README에 정보를 추가해 주세요.
- 만약에 README에서 기여자가 너무 많아서 관리가 안 되는 수준이 되면 프로젝트 루트에 CONTRIBUTORS 파일을 사용해 주세요. 이런 경우에는 CONTRIBUTORS 파일에서 "Contributors"라는 제목으로 README 페이지 내에 눈에 잘 띄게 포함되어야합니다
- 목록은 프로젝트 기여자에 대한 다음 정보가 포함된 표 형식으로 작성해야 합니다:
- 이름
- 기여자에 대해 더 많은 정보를 얻을 수 있는 사이트에 대한 URL 링크. 이 URL은 프로젝트의 재량에 따라 기여자에 의해 결정될 수 있습니다.
- 정의된 기여 카테고리 또는 기여 카테고리 이모지 이미지를 사용하여 텍스트 또는 아이콘 이미지 형식으로 기여 카테고리를 표시합니다(아래 참조).
- 기여 카테고리 또는 기여 카테고리 이모지 링크 Contribution Categories emoji.
- The list of contributors can be spread across multiple lines (each technically being its table) as needed.
- 기여자가 나열된 순서는 중요하지 않습니다. 편하신 대로 순서를 정하실 수 있습니다.
- 프로젝트는 기여도를 어떤 수준의 기여 카테고리에서든 프로젝트에 기여하는 자로 정의해야 합니다. 이 사양은 정의상 모든 기여를 포함합니다. In cases where projects deviate from the Contribution Categories or require a specific contribution level to meet criteria as a project contributor, the project should provide explicit documentation of the definitions that satisfy the project contributor criteria in the CONTRIBUTING document or a similar prominent public document at the top level of the project repository. 이 사양은 기여 수준에 따라 기여자 목록에서 개인을 제외하지 않을 것을 권장합니다. 대신, 프로젝트는 어떤 수준의 노력에서든 프로젝트에 대한 모든 기여자를 포함하는 목록 내의 노력 지표를 사용해야 합니다. 사용 된 경우, 이러한 노력 지표는 프로젝트의 재량에 달려 있으며 현재 명시되지 않았습니다.
프로 팁: @all-contributors 🤖 봇을 사용하여 오픈소스 프로젝트에 기여자를 자동으로 인정하실 수 있습니다.
옵션
프로젝트는 모든 기여자 명세에 대한 헌신의 일환으로 다음의 선택적 항목을 고려해야합니다:
- 사용자의 아바타가 포함될 수 있으며 권장됩니다.
- 아래에 상세히 기술되는 프로젝트 기여도에 대한 추가 정보를 제공하기 위해 기여 범주별 기여도에 대한 선택적 링크가 포함될 수 있습니다.