[ English | 中文 (简体, 中国) | Indonesia | Deutsch | English (United Kingdom) | español (México) | 한국어 (대한민국) ]

소개 및 목표

컨트리뷰터 가이드란?

먼저, 우리는 그저 코드 프로젝트에 대해 논의하는 것이 아닙니다. OpenStack에 기여하는 것은 OpenStack contributions come in different forms such as running meet ups, identifying use cases (Product Working Group), documentation, testing, etc. Our goal is to have these contributions valued equally.

컨트리뷰터 가이드는 모든 OpenStack 컨트리뷰터에게 공통된 문서를 제공하고, 온-보딩 작업을 도와주는 것을 목표로 합니다.

다양한 프로젝트에서 공통된 문서를 작업하면 중복 작업, 일관성 없는 문서화를 방지하는 데 도움이 되며 보다 정확한 정보를 제공할 수 있습니다. 또한 없거나 오래된 문서가 있는 프로젝트는 컨트리뷰터 가이드를 사용할 수도 있습니다.

가이드가 사용되는 곳

다양한 OpenStack 이벤트에서 컨트리뷰터 가이드는 다양한 온-보딩 프로그램을 지원하는 데 사용됩니다.

프로젝트별 컨트리뷰터 가이드

프로젝트 팀은 Examples of Documentation that’s NOT Common 에 나열된 내용을 다루기 위해 자체적으로 컨트리뷰터 문서를 보유해야합니다. 프로젝트 팀별 컨트리뷰터 가이드의 몇 가지 예로는 Nova 팀문서화 팀 이 있습니다.

콘텐츠 추가/업데이트

새로운 콘텐츠를 수정이나 추가하기 전에 먼저 OpenStack의 코드/문서 관리 방법을 숙지하십시오. 시작하려면 코드 & 문서 작성자 가이드 를 읽어보세요.

가이드를 읽은 뒤, git을 사용하여 컨트리뷰터 가이드 저장소를 복제합니다.

git clone https://opendev.org/openstack/contributor-guide

콘텐츠 가이드 라인

  • 텍스트 벽이 없습니다. 독자는 결코 다시 보지 못할 또 다른 잊혀진 탭을 가지지 않고 5 분 안에 페이지에 있는 작업을 완료 할 수 있다고 느껴야 합니다.

  • 스크린 샷을 사용하십시오.

  • 도중에 발생할 수 있는 모든 문제를 다루지 마십시오. 얼마나 일반적인지 경우에 따라 다르게 받아들여질 것입니다.

  • 비디오는 안됩니다. 너무 복잡하여 지속적으로 업데이트 할 수 없습니다.

공통 콘텐츠

컨트리뷰터 가이드는 모든 사람이 사용할 수 있도록 일반적으로 작성되었으므로 여기에 기여해야 할 몇 가지 유용한 예가 있습니다. 흔하지 ** 않는 ** 항목의 예는 컨트리뷰터 포털에 나열 될 프로젝트 팀의 특정 문서에 있어야합니다.

공통적인 문서의 예

  • Git 설정하기

  • 의사소통을 위한 IRC 설정하기

  • 의사소통을 위한 메일링 리스트 설정하기

  • Gerrit, Storyboard과 Launchpad와 같이 컨트리뷰트할 ​​적절한 계정을 설정하기

  • 선거에서 투표하는 방법

공통적이지 않은 문서의 예

  • 프로젝트 팀에서만 사용하는 특정 소프트웨어 도구

  • 버그 분류와 같은 작업을 수행하기 위한 특정 절차

좋은 문서의 예

이미 승인된 장을 사용하여 우리가 찾고 있는 내용을 파악합니다.

어떻게 도움을 시작할 수 있습니까?

버그 보고서와 작업은 모두 스토리보드 에 기록됩니다. 할당되지 않은 것이 있으면 가져갈 수 있습니다.

컨트리뷰트 도움 받기

We want you to succeed! You can ask for help on IRC OFTC in channel #openstack-doc. You can also ask for help on the OpenStack Discuss Mailing list prefixing your email subject with 〈[contributor-guide]〉. If you’re not familiar with these ways of communicating, read the 코드 & 문서 작성자 가이드.