Đóng góp vào tài liệu MVVMcross là một cách có giá trị để giúp cải thiện khung và hỗ trợ các nhà phát triển khác. Đây là hướng dẫn từng bước về cách bạn có thể đóng góp:
1. Hiểu cấu trúc tài liệu **
MVVMCROSS sử dụng Jekyll cho tài liệu của mình, có nghĩa là mỗi trang yêu cầu một vật chất phía trước của YAML. Điều này bao gồm chỉ định bố cục, tiêu đề và danh mục cho trang. Bố cục thường được đặt thành "tài liệu" trừ khi bạn chỉnh sửa một bài đăng trên blog. Các danh mục nên được sử dụng lại và được đặt tên nhất quán với các danh mục trong menu [2].2. Làm quen với Markdown **
Tài liệu sử dụng cú pháp đánh dấu tương tự như GitHub. Bạn có thể tham khảo tham chiếu Markdown của GitHub để định dạng hướng dẫn. Điều này bao gồm cách thêm các liên kết và hình ảnh tương đối vào các trang tài liệu của bạn [2].3. Thiết lập Jekyll tại địa phương **
Đối với những thay đổi lớn hơn, việc thiết lập trang web MVVMcross GitHub có ích tại địa phương với Jekyll. Điều này cho phép bạn xem trước các thay đổi của bạn trước khi gửi chúng. Bạn sẽ cần cài đặt Jekyll và làm theo hướng dẫn của GitHub để thiết lập trang web của GitHub trên cục bộ [2].4. Hướng dẫn đóng góp **
- Tiêu đề và câu: Giữ chúng ngắn gọn và súc tích. Tiêu đề nên lý tưởng là dài ba hoặc bốn từ.- Thứ tự thời gian: Mô tả các chủ đề theo trình tự logic.
- Ở lại chủ đề: Tránh đi lạc khỏi chủ đề chính.
- Ngữ pháp và dấu câu: Đảm bảo sử dụng đúng ngữ pháp và dấu câu.
- Trình kiểm tra chính tả: Sử dụng trình kiểm tra chính tả để giảm thiểu lỗi [2].
5. Gửi các khoản đóng góp của bạn **
Đóng góp thường được thực hiện thông qua các yêu cầu kéo GitHub. Bạn có thể chỉnh sửa các trang hiện có hoặc tạo những trang mới. Nếu bạn không chắc chắn về cách tiến hành, bạn có thể bắt đầu bằng cách đề xuất các thay đổi hoặc thảo luận về chúng với nhóm thông qua các vấn đề của GitHub hoặc các kênh hỗ trợ khác [1] [5].6. Tham gia với cộng đồng **
Bên cạnh việc đóng góp tài liệu, bạn cũng có thể giúp đỡ bằng cách chia sẻ kinh nghiệm của mình với MVVMcross, nộp đơn hoặc tham gia các cuộc thảo luận. Phản hồi này là vô giá để cải thiện khung [1].7. Quá trình đánh giá **
Đóng góp của bạn sẽ được xem xét để đảm bảo chúng phù hợp với phong cách tài liệu và tiêu chuẩn chất lượng. Quá trình này giúp duy trì tính nhất quán trên các tài liệu [2].Bằng cách làm theo các bước này, bạn có thể đóng góp một cách hiệu quả cho tài liệu MVVMcross và giúp nâng cao sự hiểu biết và sử dụng khung của cộng đồng.
Trích dẫn:[1] https://www.mvvmcross.com/documentation/contributing/contribution
[2] https://www.mvvmcross.com/documentation/contributing/mvvmcross-docs-style-guide
[3] https://github.com/MVVMCROSS
[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