Azure DevOps 서비스 | Azure DevOps Server | Azure DevOps Server 2022
Git 리포지토리에는 뷰어에서 코드가 수행하는 작업과 코드 사용을 시작하는 방법을 알 수 있도록 추가 정보 파일이 있어야 합니다. README 파일은 다음 독자에게 말해야 합니다.
- 코드 실행을 원하는 사용자.
- 코드를 빌드하고 테스트하려는 개발자. 개발자도 사용자입니다.
- 귀하의 코드에 변경 사항을 제출하려고 하는 참가자들입니다. 참가자는 개발자와 사용자입니다.
일반 텍스트 대신 Markdown 에 추가 정보 파일을 작성합니다. Markdown을 사용하면 쉽게 텍스트 서식을 지정하고, 이미지를 포함하고, 추가 정보 파일에서 더 많은 설명서에 연결할 수 있습니다.
다음은 이 형식을 사용하고 세 대상 그룹 모두에게 말하는 몇 가지 추가 정보 파일입니다. 참조 및 영감을 위해 사용합니다.
필수 조건
| 카테고리 | 요구 사항 |
|---|---|
| 프로젝트 액세스 | 프로젝트의 멤버입니다. |
| Permissions | - 프라이빗 프로젝트에서 코드 보기: 최소한 기본 액세스. - 프라이빗 프로젝트의 코드 복제 또는 기여: 기여자 보안 그룹의 구성원 또는 프로젝트의 해당 사용 권한입니다. - 분기 또는 리포지토리 사용 권한 설정: 관리 권한 은 분기 또는 리포지토리에 대한 권한입니다. - 기본 분기 변경: 편집 정책은 리포지토리에 대한 권한입니다. - 리포지토리 가져오기: 프로젝트 관리자 보안 그룹의 구성원이거나 Git 프로젝트 수준 리포지토리 생성 권한이 허용으로 설정되어 있어야 합니다. 자세한 내용은 Git 리포지토리 권한 설정을 참조 하세요. |
| Services | 리포지토리가 활성화되었습니다. |
| 도구 | Optional.
az repos 명령 사용: Azure DevOps CLI. |
비고
퍼블릭 프로젝트에서 관련자 액세스 권한이 있는 사용자는 코드 보기, 복제 및 기여를 포함하여 Azure Repos에 대한 모든 권한을 갖습니다.
| 카테고리 | 요구 사항 |
|---|---|
| 프로젝트 액세스 | 프로젝트의 멤버입니다. |
| Permissions | - 코드 보기: 최소한 기본 액세스. - 코드 복제 또는 기여: 기여자 보안 그룹의 구성원 또는 프로젝트의 해당 사용 권한 |
| Services | 리포지토리가 활성화되었습니다. |
소개 만들기
프로젝트를 설명하는 간단한 설명으로 README 파일을 시작하십시오. 프로젝트에 사용자 인터페이스가 있는 경우 소개에 스크린샷 또는 애니메이션 GIF를 추가합니다. 코드가 다른 애플리케이션 또는 라이브러리를 사용하는 경우 해당 종속성을 소개 또는 바로 아래에 명시해야 합니다. 특정 플랫폼에서만 실행되는 앱 및 도구에는 README 파일의 이 섹션에서 설명하는 지원되는 운영 체제 버전이 있어야 합니다.
사용자가 시작하는 데 도움이 됩니다.
추가 정보 파일의 다음 섹션에서는 사용자가 자신의 시스템에서 코드를 시작하고 실행하는 것을 안내합니다. 코드를 시작하기 위한 필수 단계에 집중하세요. 사용자가 쉽게 사용할 수 있도록 필수 구성 요소 소프트웨어의 필수 버전에 연결합니다. 복잡한 설정 단계가 있는 경우 추가 정보 파일 외부에서 해당 단계를 문서화하고 해당 단계에 연결합니다.
최신 릴리스를 가져올 위치를 독자에게 알릴 수 있습니다. 다음 항목 중 하나를 제공합니다.
- 이진 설치 관리자 또는 미리 빌드된 패키지에 대한 링크입니다.
- 패키지 관리자를 사용하여 설치 지침(예: npm 설치, pip 설치 또는 dotnet add package).
프로젝트가 라이브러리 또는 API 래퍼인 경우 기본 사용량을 보여 주는 최소 코드 조각과 예상 출력을 포함합니다. 이 정보는 독자가 설정을 확인하고 라이브러리가 수행하는 작업을 한눈에 이해하는 데 도움이 됩니다.
개발자를 위한 빌드 단계 제공
README 파일의 다음 섹션을 사용하여 개발자에게 리포지토리의 새 클론에서 코드를 빌드하고 포함된 테스트를 실행하는 방법을 보여 줍니다. 다음 단계를 수행합니다.
- 코드를 빌드하는 데 필요한 도구에 대한 세부 정보를 제공하고 새로 빌드하도록 구성하는 단계를 문서화합니다.
- 조밀하거나 복잡한 빌드 지침을 설명서의 별도 페이지로 나누어 필요한 경우 연결합니다.
- 작성할 때 지침을 실행하여 지침이 새 참가자에게 작동하는지 확인합니다.
기억하세요, 당신이 한동안 프로젝트에서 작업하지 않은 후 이러한 지침을 사용할 개발자일 수 있습니다.
빌드가 성공한 후 소스 코드와 함께 제공되는 테스트 사례를 실행하는 명령을 포함합니다. 개발자는 코드 변경 시 이를 통해 코드를 손상시키지 않도록 하려고 테스트 케이스에 의존합니다. 좋은 테스트 사례는 개발자가 새 기능을 추가할 때 자체 테스트 사례를 빌드하는 데 사용할 수 있는 샘플 역할을 합니다.
사용자가 기여할 수 있도록 지원
README 파일의 마지막 섹션은 사용자와 개발자가 문제를 보고하고 코드를 개선하기 위한 아이디어를 제안하는 데 도움이 됩니다. 사용자는 버그를 열거나, 기능을 요청하거나, 코드를 사용하여 도움을 받을 수 있는 채널에 연결되어야 합니다.
개발자는 코딩/테스트 지침 및 끌어오기 요청 요구 사항과 같은 변경 내용을 적용하기 위해 따라야 하는 규칙을 알아야 합니다. 끌어오기 요청을 수락하거나 커뮤니티 행동 강령을 적용하기 위해 기여자 계약이 필요한 경우 이 프로세스는 이 섹션에 연결되거나 문서화되어야 합니다. 코드가 릴리스된 라이선스를 명시하고 라이선스의 전체 텍스트에 연결합니다.