MVVMCross 문서에 기여하는 것은 프레임 워크를 개선하고 다른 개발자를 지원하는 데 도움이되는 귀중한 방법입니다. 다음은 기여하는 방법에 대한 단계별 안내서입니다.
1. 문서 구조 이해 **
MVVMCross는 문서에 Jekyll을 사용합니다. 즉, 각 페이지에는 Yaml Front Matter가 필요합니다. 여기에는 페이지의 레이아웃, 제목 및 카테고리를 지정하는 것이 포함됩니다. 블로그 게시물을 편집하지 않는 한 레이아웃은 일반적으로 "문서화"로 설정됩니다. 메뉴 [2]의 기존 카테고리와 일관되게 재사용하고 이름을 지정해야합니다.2. Markdown에 익숙해집니다 **
이 문서는 Github와 동일한 Markdown 구문을 사용합니다. 서식 지침에 대해서는 Github의 Markdown 참조를 참조 할 수 있습니다. 여기에는 문서 페이지에 상대 링크와 이미지를 추가하는 방법이 포함됩니다 [2].3. 현지에서 Jekyll 설정 **
더 큰 변화의 경우 Jekyll과 함께 로컬로 MVMCross Github 페이지 사이트를 설정하는 것이 좋습니다. 이를 통해 제출하기 전에 변경 사항을 미리 볼 수 있습니다. Jekyll을 설치하고 Github 페이지 사이트를 로컬로 설정하기위한 Github의 지침을 따라야합니다 [2].4. 기부 지침 **
- 제목과 문장 : 짧고 간결하게 유지하십시오. 제목은 이상적으로 3-4 단어 길이 여야합니다.- 연대순 순서 : 논리적 순서로 주제를 설명합니다.
- 주제를 유지하십시오 : 주요 주제에서 길을 잃지 마십시오.
- 문법 및 구두점 : 문법과 문장 부호를 올바르게 사용하십시오.
- 맞춤법 검사기 : 맞춤법 검사기를 사용하여 오류를 최소화합니다 [2].
5. 기부금 제출 **
기부금은 일반적으로 Github Pull 요청을 통해 이루어집니다. 기존 페이지를 편집하거나 새 페이지를 만들 수 있습니다. 진행 방법에 대해 확신이 없다면 GitHub 문제 또는 기타 지원 채널을 통해 변경 사항을 제안하거나 팀과 논의하여 시작할 수 있습니다 [1] [5].6. 커뮤니티에 참여 **
문서를 기고하는 것 외에도 MVVMCross와의 경험을 공유하거나 버그를 제출하거나 토론에 참여함으로써 도움을 줄 수 있습니다. 이 피드백은 프레임 워크를 개선하는 데 매우 중요합니다 [1].7. 검토 프로세스 **
귀하의 기여는 문서 스타일 및 품질 표준에 맞도록 검토됩니다. 이 과정은 문서 전체의 일관성을 유지하는 데 도움이됩니다 [2].이러한 단계를 수행함으로써 MVVMCross 문서에 효과적으로 기여하고 프레임 워크의 이해와 사용을 향상시키는 데 도움이 될 수 있습니다.
인용 :[1] https://www.mvvmcross.com/documentation/contributing/contribute
[2] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[3] https://github.com/mvvmcross/mvvmcross/blob/develop/contributing.md
[4] https://www.mvvmcross.com/documentation/advanced/customizing-using-app-and-setup
[5] https://www.mvvmcross.com/documentation/
[6] https://github.com/mapsui/mapsui/issues/747
[7] https://www.mvvmcross.com/documentation/getting-started/mvvmcross-overview
[8] https://stackoverflow.com/questions/51552868/mvvmcross-complete-api-documentation-list/51553028
[9] https://www.mvvmcross.com/documentation/fundamentals/viewmodel-lifecycle
[10] https://github.com/mvvmcross/mvvmcross