MVVMCross의 GitHub 문제를 포맷 할 때 모범 사례에 따라 명확성, 효율성 및 협업을 향상시킬 수 있습니다. 자세한 지침은 다음과 같습니다.
1. 설명 제목 **
명령적인 분위기를 사용하고 제목이 문제의 목적을 전달하기에 충분히 설명 적인지 확인하십시오. 기간이있는 제목을 끝내지 마십시오. 예를 들어, "데이터 바인딩의 버그 수정"은 "데이터 바인딩의 버그"또는 "데이터 바인딩 버그"보다 효과적입니다. [4] [7].2. 명확한 개요 **
이 문제에 대한 간결한 개요를 두 줄 이내에 제공합니다. 여기에는 주요 목표 또는 해결중인 문제가 포함되어야합니다. 예를 들어, "이 문제는 Android 장치에서 앱 충돌을 일으키는 데이터 바인딩 오류를 해결하는 것을 목표로합니다."[1] [4].3. 종속성 (해당되는 경우) **
문제가 먼저 해결되는 다른 문제에 의존하는 경우 해당 문제에 링크하십시오. 이를 통해 명확한 워크 플로를 유지하고 종속 작업이 올바른 순서로 해결되도록합니다. 예를 들어, "이 문제는 [종속 문제에 대한 링크]에 달려 있습니다."[1].4. 액션 아이템 **
클릭 가능한 체크리스트로 액션 항목을 형식화하십시오. 이를 통해 진행 상황을 쉽게 추적하고 팀원에게 작업을 할당 할 수 있습니다. 예를 들어:- [] 데이터 바인딩 오류의 원인을 조사하십시오.
- [] 식별 된 문제에 대한 수정을 구현하십시오.
- [] 여러 플랫폼에서 수정을 테스트하십시오. [1] [4].
5. 자원/지침 **
문제 해결에 도움이 될 수있는 관련 문서 또는 리소스에 대한 링크를 포함하십시오. 여기에는 자습서, API 문서 또는 문제와 관련된 이전 토론이 포함될 수 있습니다. 예를 들어, 데이터 바인딩에 대한 지침은 "[MVVMCross 문서] (https://mvvmcross.com/docs)을 참조하십시오."[1] [2].6. 양수인 **
특정 팀원에게 문제를 할당하십시오. 이를 통해 과제에 대한 책임이있는 사람에 대한 책임과 명확성을 보장합니다. GitHub의 "양수인"기능을 사용하여 사용자를 할당하십시오. [1].7. 레이블 **
관련 레이블을 적용하여 문제를 분류하십시오. 이를 통해 프로젝트 내에서 문제를 필터링하고 우선 순위를 정하는 데 도움이됩니다. 예를 들어, 레이블에는 "버그", "기능"또는 "향상"이 포함될 수 있습니다. [1] [2].8. 프로젝트 보드 **
문제가 프로젝트 보드에 추가되어 올바르게 분리되어 있는지 확인하십시오. 여기에는 준비가되지 않은 경우 "Ice Box"로 문제 상태를 설정하고 준비가되었지만 할당되지 않은 경우 "우선 백 로그", 일단 할당 된 "진행 중"이 포함됩니다. [1].9. 이정표 **
이정표를 사용하여 문제 그룹의 진행 상황을 추적하거나 요청을 당기십시오. 이것은 대규모 프로젝트 나 여러 관련 작업을 추적 할 때 특히 유용합니다. [1].10. 문서 및 진행 상황 업데이트 **
진행 상황이나 변경으로 문제 의견을 정기적으로 업데이트하십시오. 이것은 모든 이해 관계자에게 정보를 제공하고 협력 문제 해결을 촉진합니다. [7].잘 구성된 문제의 예
** 제목 : Android 장치의 데이터 바인딩 오류 수정
** 개요 :이 문제는 Android 장치에서 앱 충돌을 일으키는 데이터 바인딩 오류를 해결합니다.
** 종속성 : [종속 문제에 대한 링크]에 따라 다릅니다.
액션 아이템 :
- [] 데이터 바인딩 오류의 원인을 조사하십시오.
- [] 결과에 따라 수정을 구현하십시오.
- [] 플랫폼에서 철저한 테스트를 수행합니다.
** 리소스/지침 : 데이터 바인딩 안내는 [MVVMCross Documentation] (https://mvvmcross.com/docs)를 참조하십시오.
** 양수인 : @username
** 레이블 : 버그, 안드로이드
이 지침을 따르면 MVVMCross 프로젝트 내에서 협업 및 효율성을 향상시키는 잘 구조화 된 GitHub 문제를 만들 수 있습니다.
인용 :[1] https://www.hackforla.org/guide-pages/github-issues.html
[2] https://github.com/mvvmcross/mvvmcross
[3] https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-tables
[4] https://tilburggsciencehub.com/topics/automation/version-control/start/write-good-issues/
[5] https://github.com/mvvmcross/mvvmcross-samples
[6] https://github.com/mvvmcross/mvvmcross-samples/blob/master/readme.md
[7] https://gitprotect.io/blog/mastering-github-issues-best-practices-and-pro-tips/
[8] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[9] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md