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 Phần Google 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 cho người mới bắt đầu sử dụng FLINT
Thời lượng dự án:: Thời gian 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 về kỹ thuật dành cho FLINT nhằm hướng dẫn những người đóng góp mới thông qua quy trình làm quen kỹ thuật để những người đóng góp mới có thể dễ dàng bắt đầu với sự hỗ trợ tối thiểu từ những người bảo trì.

Vấn đề về dự án

Sau đây là danh sách các 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 thiết lập cục bộ thiếu ngăn nắp, do đó gây khó khăn cho người đóng góp mới 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, khiến người dùng mới khó xác định được kho lưu trữ nào sẽ được cài đặt. – Việc cài đặt Windows được ghi lại đầy đủ nhưng tài liệu cài đặt trên Linux vẫn có chỗ cần cải thiện. – Quy trình công việc của Git hiện không nằm trong 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 làm quen kỹ thuật, giúp những người đóng góp mới có thể dễ dàng bắt đầu với sự hỗ trợ tối thiểu từ những người bảo trì. Điều này có thể đạt được 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 trở nên 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 có sẵn. Dự án được chia thành ba giai đoạn: – – Xem lại tài liệu hiện có và tái cấu trú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 hướng dẫn theo cách ngắn gọn và dễ hiểu đối với người đóng góp mới. Bạn cũng cần chỉnh sửa tài liệu này sao cho phù hợp hơn với những người mới tham gia 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 nhãn là chỉ dành cho người mới tham gia hoặc thẻ vấn đề phù hợp cho người mới tham gia. – 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 toàn bộ 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 đó có cả 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 git đóng góp và kiến trúc công nghệ của dự án cùng với nguyên tắc kiểm thử và đả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 làm việc, các vấn đề lần đầu tiên có thể được cộng tác viên mới xác nhận và danh sách tất cả cộng tác viên. Giai đoạn 1: Xem xét 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 chi tiết lắm 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 và ngắn gọn hơn. Ngoài ra, hướng dẫn cài đặt cũng được phục vụ cho các cửa sổ, nhưng việc chuyển hướng việc cài đặt Linux đế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, mà là cung cấp quá trình 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 tập trung vào cách thức tuần tự để thiết lập dockerfile và cũng có đủ thông tin về cách tạo từ makefile. – FLINT.example: 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, mà là để cung cấp ví dụ về cách sử dụng FLINT. Bạn có thể phân tách tốt hơn các lần chạy mẫu khác nhau bằng 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 để cung cấp cho người dùng cách di chuyển tại đây để 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: – Cách 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, sao chép và sau đó thiết lập luồng ngược từ xa cho kho lưu trữ. Hướng dẫn này cũng sẽ cung cấp thông tin về cách chuyển đổi lại dựa trên bản tổng quan 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 Huy hiệu và biểu tượng cảm xúc có thể giúp những người đóng góp mới cảm thấy được chào đón và bớt gây phiền toái. – Thông tin về các vấn đề phù hợp với người mới bắt đầu/người dùng lần đầu: 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 tính năng này. Bạn cần cập nhật kho lưu trữ này để đề cập đến kho lưu trữ Import-me 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, nhà lập trình cũng nên thiết lập một quy trình để đề xuất các tính năng bổ sung cho kho lưu trữ Import-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à Read The 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. – Tự động cập nhật khi đẩy cam kết – Dễ thiết lập và hỗ trợ khắc phục sự cố nhờ có cộng đồng lớn sử dụng – Tài liệu được định dạng bằng reStructureText và kết quả 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 được đề xuất như sau:- – Giới thiệu về 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ặt lập trình/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ử”. – Tham gia cùng chúng tôi: Phần này sẽ cung cấp các diễn đàn xã hội, 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 làm 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 dành cho nhà phát triển:

Tài liệu về quy trình làm 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ông nghệ/Cấu trúc được sử dụng và nhiều mô-đun khác nhau trong mã: Tài liệu giúp những người đóng góp mới làm quen với Ngăn xếp công nghệ đã được triển khai, các thư viện và mô-đun khác nhau của cơ sở mã.
Các công cụ tích hợp để kiểm tra và mức độ phù hợp: Giới thiệu những người đóng góp mới cho các công cụ quy trình CI/CD dùng để thử nghiệm, bot về Mức độ phù hợp và Kiểm tra chất lượng tự động sẽ chạy dựa trên mã của họ. Đồng thời cung cấp cho họ hướng dẫn về đối tượng cần tiếp cận nếu kiểm thử không đạt.
Sử dụng bot để đơn giản hoá quy trình làm việc, ví dụ: Zulipbot: Thiết kế mẫu nội dung cho bot hiển thị và Tài liệu sẵn có để cho phép người dùng hiểu về bot và thậm chí 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 yêu cầu lấy dữ liệu theo các tiêu chuẩn nhất định và tải kết quả lên dưới dạng ảnh chụp màn hình/ảnh GIF khi gửi Yêu cầu lấy dữ liệu.
Đưa ra các nguyên tắc về yêu cầu xem xét mà cộng tác viên phải tuân theo: 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 xem xét để cho phép những người bảo trì 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 làm việc của chúng tôi: Quy trình làm việc sẽ bao gồm chuỗi hành động mà một cộng tác viên mới có thể bắt đầu, chẳng hạn như xác nhận sự cố về đồng hồ hẹn giờ đầu tiên, tiếp đến 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 và xem xét yêu cầu lấy dữ liệu của họ.
Danh sách vấn đề chỉ dành cho người dùng lần đầu tiên: Danh sách các vấn đề chỉ dành cho người dùng lần đầu hoặc người đóng góp mới.
Danh sách vấn đề đã cũ: Danh sách các vấn đề chưa đượ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 cho kho lưu trữ Moja Global.
Người đóng góp gần đây: Danh sách người đóng góp gần đây đã đóng góp cho 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 nhằm giải đáp các thắc mắc của họ và thảo luận thêm về các dự án.