Trang này được dịch bởi Cloud Translation API.

dự án moja trên toàn cầu

Trang này chứa thông tin chi tiết về một dự án viết kỹ thuật được chấp nhận cho Google Phần Tài liệu.

Tóm tắt dự án

Tổ chức nguồn mở:: moja toàn cầu
Người viết nội dung kỹ thuật:: Tlazypanda
Tên dự án:: Tài liệu hướng dẫn kỹ thuật cho người mới bắt đầu dùng FLINT
Thời lượng dự án:: Thời lượng tiêu chuẩn (3 tháng)

Mô tả dự án

Tài liệu Hướng dẫn cho người mới tham gia FLINT nhằm hướng dẫn cộng tác viên mới thông qua quy trình làm quen với kỹ thuật, sao cho cộng tác viên mới có thể dễ dàng làm quen với sự hỗ trợ tối thiểu từ nhà duy trì.

Vấn đề về dự án

Sau đây là danh sách vấn đề quan trọng nhất liên quan đến tài liệu hiện tại: – Các phần hướng dẫn hướng dẫn thiết lập cục bộ chưa được sắp xếp hợp lý, khiến cộng tác viên mới gặp khó khăn khi bắt đầu. – Nhiều kho lưu trữ FLINT không có tài liệu về mục đích và không được liên kết với nhau, gây khó khăn cho người mới lưu trữ trong việc xác định kho lưu trữ nào sẽ được cài đặt. – Việc cài đặt Windows được ghi chép rõ ràng nhưng tài liệu về việc cài đặt dựa trên Linux vẫn có chỗ cần cải thiện. - Quy trình công việc Git hiện không phải là một phần của tài liệu

Giải pháp Đề xuất

Đề xuất này đưa ra giải pháp hướng dẫn cộng tác viên mới thông qua quy trình giới thiệu kỹ thuật để cộng tác viên mới có thể dễ dàng bắt đầu với sự hỗ trợ tối thiểu từ những người duy trì. Bạn có thể thực hiện việc này bằng cách tái cấu trúc tài liệu hiện tại để làm cho tài liệu này thân thiện với người mới bắt đầu, đồng thời duy trì kho lưu trữ độc lập trung tâm cho mọi tài liệu hiện có. Dự án được chia thành 3 giai đoạn:– – Xem lại và tái cấu trúc tài liệu hiện có: Mục tiêu của giai đoạn này là xem lại hướng dẫn hiện tại và tái cấu trúc theo cách ngắn gọn và dễ hiểu đối với những người đóng góp mới. Bạn cũng cần chỉnh sửa tài liệu này để tài liệu trở nên thân thiện hơn với người mới bắt đầu bằng cách thêm huy hiệu, biểu tượng cảm xúc và thông tin về các vấn đề được gắn thẻ là chỉ dành cho người dùng lần đầu hoặc thẻ vấn đề tốt cho người mới bắt đầu. – Tạo kho lưu trữ tài liệu độc lập trung tâm: Mục tiêu của giai đoạn này là liên kết tất cả tài liệu có sẵn theo thứ tự tuần tự logic tại một kho lưu trữ độc lập. Trong đó bao gồm việc sắp xếp thứ tự các nguyên tắc đóng góp, hướng dẫn thiết lập dự án và hướng dẫn từng bước. – Thêm quy trình làm việc dành cho nhà phát triển và trang web cộng đồng cho nhà phát triển mới: Mục tiêu của giai đoạn này là thêm quy trình làm việc dành cho nhà phát triển có chứa nguyên tắc về đóng góp git và kiến trúc công nghệ của dự án cùng với nguyên tắc kiểm thử và nguyên tắc đảm bảo chất lượng. Trang web cộng đồng được đề xuất sẽ là một ứng dụng trang đơn hiển thị quy trình công việc, những vấn đề của người tham gia lần đầu mà những người đóng góp mới có thể đã xác nhận quyền sở hữu, cũng như danh sách tất cả cộng tác viên. Giai đoạn 1: Xem lại tài liệu hiện có và tái cấu trúc:

Sửa đổi tài liệu hiện tại của các kho lưu trữ sau: – FLINT: Tài liệu hiện tại không quá chi tiết và không cung cấp thứ tự tuần tự của các thư viện tiên quyết bắt buộc. Hướng dẫn từng bước được chia thành các tệp pdf khác nhau nhưng có thể được hợp nhất ở một nơi duy nhất theo cách ngắn gọn hơn. Ngoài ra, hướng dẫn cài đặt được dành riêng cho cửa sổ nhưng đối với việc cài đặt Linux, việc chuyển hướng đến kho lưu trữ FLINT.docker có thể có lợi. – FLINT.docker: Tài liệu hiện tại không cung cấp mục đích đằng sau việc thiết lập kho lưu trữ này là cung cấp việc cài đặt FLINT trên Linux thông qua docker. Hỗ trợ thông qua docker chỉ giới hạn ở Ubuntu 18.04 (Bionic Beaver) nhưng có thể được mở rộng sang các bản phân phối dựa trên Linux khác. Tài liệu hiện tại cũng cần nhấn mạnh vào cách thức tuần tự để thiết lập các tệp dockerfile, đồng thời cũng cần có đầy đủ thông tin về cách tạo từ tệp makefile. – FLINT.example: Tài liệu hiện tại không cung cấp mục đích của việc thiết lập kho lưu trữ này là để cung cấp ví dụ về cách sử dụng FLINT. Bạn có thể phân tách các lần chạy mẫu khác nhau theo hướng dẫn cụ thể để chạy. Chúng ta cũng cần liên kết kho lưu trữ này với kho lưu trữ FLINT chính để người dùng có thể di chuyển đến đây và xem ví dụ thực tế.

Bạn cần thêm thông tin sau vào tài liệu hiện tại: – Sử dụng Git và GitHub: Bao gồm hướng dẫn từng bước về cách phát triển nhánh, nhân bản và sau đó thiết lập luồng ngược từ xa cho kho lưu trữ. Bài viết này cũng sẽ cung cấp thông tin về cách dựa vào bản chính mới nhất và xử lý các xung đột hợp nhất. - Huy hiệu và biểu tượng cảm xúc: Tài liệu hiện tại thiếu các Huy hiệu và Biểu tượng cảm xúc để giúp những người đóng góp mới cảm thấy được chào đón và giảm bớt các vấn đề gây khó khăn. – Thông tin về các vấn đề phù hợp với người mới bắt đầu/người dùng mới: Thông tin này sẽ giúp chuyển hướng những người đóng góp mới đến các vấn đề phù hợp với người mới bắt đầu và trang web cộng đồng. – Thông tin về kho lưu trữ Import-me: Kho lưu trữ Import-me hoạt động như một mẫu cơ sở để bắt đầu bất kỳ kho lưu trữ Moja Global nào. Tài liệu hiện tại không đề cập đến tầm quan trọng của vấn đề này. Bạn cần cập nhật kho lưu trữ này để đề cập đến kho lưu trữ Nhập-tôi và các bước để chọn kho lưu trữ này làm mẫu khi tạo kho lưu trữ mới cũng cần được thêm vào. Ngoài ra, họ cũng cần có một quy trình thiết lập để lập trình viên đề xuất thêm các tính năng cho kho lưu trữ Nhập-me.

Giai đoạn 2: Tạo kho lưu trữ tài liệu độc lập trung tâm :

Công cụ được sử dụng cho nền tảng lưu trữ:

Công cụ được đề xuất cho nền tảng lưu trữ này là Đọc tài liệu vì những lý do sau:- – Được xếp hạng cao trong số các nền tảng lưu trữ khác nhau. – Nâng cấp tự động khi nhấn vào cam kết – Dễ dàng thiết lập và hỗ trợ khắc phục sự cố dễ dàng do có cộng đồng lớn sử dụng – Tài liệu được định dạng bằng cách sử dụng reStructureText và dữ liệu đầu ra do Sphinx biên dịch.

Sắp xếp tất cả nội dung theo tuần tự logic:

Thứ tự nội dung đề xuất như sau:– – Giới thiệu tài liệu dành cho nhà phát triển: Phần này giới thiệu về Moja Global và FLINT. – Đóng góp: Phần này sẽ bao gồm các tiểu mục “Cách đóng góp” (về mã/báo cáo lỗi/bản dịch/tài liệu/tổ chức sự kiện, v.v.) và “Quy tắc ứng xử”. – Thiết lập phát triển: Phần này bao gồm các tiểu mục “Quy trình làm việc trên Git & GitHub”, “Cài đặt Windows”, “Cài đặt Linux”. Phần này bao gồm nội dung thảo luận về các công cụ tích hợp để kiểm thử và cách thực hiện kiểm thử thủ công trong giai đoạn tiếp theo. – Tham gia cùng chúng tôi: Phần này sẽ giới thiệu các diễn đàn xã hội khác nhau, chẳng hạn như các kênh Slack để kết nối và làm việc với Moja Global.

Giai đoạn 3: Thêm quy trình công việc dành cho nhà phát triển và trang web cộng đồng cho cộng tác viên mới:

Tài liệu về quy trình công việc của nhà phát triển:

Tài liệu về quy trình công việc dành cho nhà phát triển sẽ bao gồm các tiểu mục sau:

Ngăn xếp/Cấu trúc công nghệ sử dụng và các mô-đun khác nhau trong mã: Tài liệu để làm quen với những người đóng góp mới đã triển khai Ngăn xếp công nghệ, các thư viện và mô-đun khác nhau của cơ sở mã.
Các công cụ thử nghiệm và mức độ phù hợp tích hợp: Giới thiệu những cộng tác viên mới sử dụng các công cụ quy trình CI/CD dùng để kiểm thử, bot về mức độ phù hợp và tính năng Kiểm tra chất lượng tự động sẽ chạy dựa trên mã nguồn của họ. Đồng thời hướng dẫn họ về đối tượng cần tiếp cận nếu kiểm thử không đạt.
Các bot được dùng để đơn giản hoá quy trình làm việc, ví dụ: Zulipbot: Thiết kế các mẫu nội dung cho bot sẽ hiển thị và Tài liệu có sẵn để cho phép người dùng hiểu về bot và thậm chí là cải thiện cấu hình của bot bằng cách đóng góp.
Kiểm thử và gửi yêu cầu lấy dữ liệu theo cách thủ công: Tài liệu về cách kiểm thử thủ công các Yêu cầu lấy dữ liệu dựa trên một số tiêu chuẩn nhất định, đồng thời cung cấp kết quả tải lên về ảnh chụp màn hình/ảnh GIF khi gửi Yêu cầu lấy dữ liệu.
Lấy nguyên tắc về yêu cầu xem xét mà cộng tác viên phải tuân thủ: Nguyên tắc gắn thẻ một số nhóm nhất định để xem xét và thêm các nhãn (chẳng hạn như "cần xem xét" vào yêu cầu phân phối) để những người duy trì có thể phản hồi.

Trang web cộng đồng:

Trang web cộng đồng sẽ có các tính năng sau:-

Thông tin về Quy trình công việc: Quy trình công việc sẽ bao gồm các hành động mà người đóng góp mới có thể bắt đầu, tức là xác nhận vấn đề về việc hẹn giờ đầu tiên, tiếp theo là tạo vấn đề về đồng hồ hẹn giờ đầu tiên cho người khác và giúp người khác bằng cách đưa ra ý kiến phản hồi cũng như xem xét yêu cầu lấy dữ liệu của họ.
Danh sách các vấn đề chỉ áp dụng cho Chương trình hẹn giờ đầu tiên: Danh sách các vấn đề dành riêng cho người dùng lần đầu hoặc cộng tác viên mới.
Danh sách vấn đề đã tồn tại: Danh sách các vấn đề đã không được giải quyết trong một thời gian dài nên cộng tác viên có thể chọn.
Danh sách người đóng góp: Danh sách những người đóng góp cho đến nay đã đóng góp vào kho lưu trữ Moja Global.
Người đóng góp gần đây: Danh sách những người đóng góp gần đây đã đóng góp vào kho lưu trữ Moja Global.
Đường liên kết để tham gia diễn đàn trò chuyện: Thông tin và đường liên kết để tham gia cộng đồng Slack để giải đáp thắc mắc của họ và thảo luận thêm về các dự án.