리포지토리용 추가 정보 만들기

  • 아티클

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

Git 리포지토리에는 뷰어에서 코드가 수행하는 작업과 코드 사용을 시작하는 방법을 알 수 있도록 추가 정보 파일이 있어야 합니다. 추가 내용은 다음 대상 그룹에 대해 설명해야 합니다.

  • 코드를 실행하려는 사용자입니다.
  • 코드를 빌드하고 테스트하려는 개발자. 개발자도 사용자입니다.
  • 코드에 변경 내용을 제출하려는 참가자입니다. 참가자는 개발자와 사용자입니다.

일반 텍스트 대신 Markdown에 추가 내용을 작성합니다. Markdown을 사용하면 필요에 따라 텍스트 서식을 지정하고, 이미지를 포함하고, 추가 정보에서 더 많은 설명서에 연결할 수 있습니다.

다음은 이 형식을 사용하고 참조 및 영감을 얻기 위해 세 명의 청중에게 말하는 몇 가지 훌륭한 추가 정보입니다.

소개 만들기

프로젝트를 설명하는 간단한 설명으로 추가 작업을 시작합니다. 프로젝트에 사용자 인터페이스가 있는 경우 소개에 스크린샷 또는 애니메이션 GIF를 추가합니다. 코드가 다른 애플리케이션 또는 라이브러리를 사용하는 경우 해당 종속성을 소개 또는 바로 아래에 명시해야 합니다. 특정 플랫폼에서만 실행되는 앱 및 도구에는 이 추가 정보 섹션에서 설명하는 지원되는 운영 체제 버전이 있어야 합니다.

사용자가 시작하는 데 도움이 됩니다.

추가 정보의 다음 섹션에서 사용자 고유의 시스템에서 코드를 시작하고 실행하는 것을 안내합니다. 코드를 시작하기 위한 필수 단계에 집중하세요. 사용자가 쉽게 사용할 수 있도록 필수 구성 요소 소프트웨어의 필수 버전에 연결합니다. 복잡한 설정 단계가 있는 경우 추가 정보 외부의 단계를 문서화하고 연결합니다.

코드의 최신 릴리스를 가져올 위치를 가리킵니다. 패키징 도구를 통해 코드를 사용하는 방법에 대한 이진 설치 관리자 또는 지침이 가장 좋습니다. 프로젝트가 API에 대한 라이브러리 또는 인터페이스인 경우 기본 사용을 보여 주는 코드 조각을 배치하고 해당 코드 조각의 코드에 대한 샘플 출력을 표시합니다.

개발자를 위한 빌드 단계 제공

추가 정보의 다음 섹션을 사용하여 리포지토리의 새 클론에서 코드를 빌드하고 포함된 테스트를 실행하는 방법을 개발자에게 보여 줍니다. 다음을 수행하십시오:

  • 코드를 빌드하는 데 필요한 도구에 대한 세부 정보를 제공하고 클린 빌드를 사용하도록 구성하는 단계를 문서화합니다.
  • 조밀하거나 복잡한 빌드 지침을 설명서의 별도 페이지로 나누어 필요한 경우 연결합니다.
  • 지침이 새 기여자 대해 작동하는지 확인하기 위해 작성할 때 지침을 실행합니다.

이러한 지침에 의존하는 개발자는 잠시 동안 프로젝트를 작업하지 않은 후 사용자가 될 수 있습니다.

빌드가 성공한 후 소스 코드와 함께 제공되는 테스트 사례를 실행하는 명령을 제공합니다. 개발자는 이러한 테스트 사례에 의존하여 코드를 변경할 때 코드를 중단하지 않도록 합니다. 좋은 테스트 사례는 개발자가 새 기능을 추가할 때 자체 테스트 사례를 빌드하는 데 사용할 수 있는 샘플 역할을 합니다.

사용자가 기여할 수 있도록 지원

추가 정보의 마지막 섹션은 사용자와 개발자가 문제를 보고하는 데 참여하고 코드를 개선하기 위한 아이디어를 제안하는 데 도움이 됩니다. 사용자는 버그를 열거나, 기능을 요청하거나, 코드를 사용하여 도움을 받을 수 있는 채널에 연결되어야 합니다.

개발자는 코딩/테스트 지침 및 끌어오기 요청 요구 사항과 같은 변경 내용을 적용하기 위해 따라야 하는 규칙을 알아야 합니다. 끌어오기 요청을 수락하거나 커뮤니티 행동 강령을 적용하기 위해 기여자 계약이 필요한 경우 이 프로세스는 이 섹션에 연결되거나 문서화되어야 합니다. 코드가 릴리스된 라이선스를 명시하고 라이선스의 전체 텍스트에 연결합니다.