Mẹo bắt đầu đóng góp cho các dự án nguồn mở của Ultralytics

Nền tảng của phần mềm mã nguồn mở là sự cộng tác, học hỏi và chia sẻ. Các dự án mã nguồn mở là một cách tuyệt vời để mọi người cùng nhau xây dựng điều gì đó lớn lao hơn chính bản thân họ. Tại Ultralytics, chúng tôi luôn trân trọng các nguyên tắc của mã nguồn mở và khuyến khích bạn đóng góp cho các dự án mã nguồn mở của chúng tôi.

Nếu bạn hào hứng muốn đóng góp, dù là viết tài liệu, review code hay xử lý issue, nhưng chưa biết bắt đầu từ đâu hoặc đang gặp một số vấn đề, chúng tôi sẵn sàng giúp bạn bắt đầu. Trong bài viết này, chúng tôi sẽ hướng dẫn một số mẹo để bắt đầu đóng góp cho các dự án mã nguồn mở của Ultralytics. Hãy cùng tìm hiểu ngay!

Tầm quan trọng của những đóng góp từ cộng đồng Ultralytics#

Trước khi tìm hiểu cách đóng góp, hãy cùng trả lời câu hỏi vì sao những đóng góp lại quan trọng đến vậy. Chúng tôi thực sự tin tưởng vào tầm quan trọng của những đóng góp từ cộng đồng Ultralytics. Khi tham gia các dự án mã nguồn mở của chúng tôi, bạn không chỉ giúp chúng tôi xây dựng phần mềm tốt hơn. Những người đóng góp đóng vai trò then chốt trong việc đảm bảo công nghệ của chúng tôi luôn cởi mở, có tính cộng tác và không ngừng phát triển. Những đóng góp của bạn giúp các dự án của chúng tôi phát triển mạnh mẽ, dễ tiếp cận và mang lại lợi ích cho người dùng cũng như developer trên toàn thế giới!

Bên cạnh việc tạo ra phần mềm tiên tiến, đóng góp cho các dự án của Ultralytics cũng là một cơ hội tuyệt vời để bạn phát triển bản thân. Bạn có thể nâng cao kỹ năng coding, giải quyết vấn đề và làm việc nhóm khi cộng tác với các developer giàu kinh nghiệm, những người có thể hướng dẫn và chia sẻ các best practice. Nỗ lực của bạn có thể tạo ra tác động thực tế đến các công cụ được hàng nghìn người trên toàn cầu sử dụng. Tham gia cộng đồng cũng có thể giúp bạn mở rộng mạng lưới chuyên môn, mở ra những cơ hội mới và nâng cao portfolio để tạo ấn tượng với nhà tuyển dụng.

Hình 1. Lý do đóng góp. Hình ảnh của tác giả.

Cách bắt đầu đóng góp cho mã nguồn mở của Ultralytics#

Một điểm khởi đầu tuyệt vời là xem hướng dẫn đóng góp chính thức của Ultralytics. Tài liệu này cung cấp nhiều best practice và mẹo giúp bạn đóng góp hiệu quả nhất. Bước đầu tiên là làm quen với những gì đã có trong dự án bằng cách tìm hiểu hướng dẫn đóng góp và đọc kỹ code.

Dù bạn muốn đóng góp vào quá trình phát triển hay chỉ muốn khám phá code mới nhất, bước tiếp theo là clone repository Ultralytics. Sau đó, bạn có thể chuyển đến thư mục dự án và cài đặt package ở chế độ editable như minh họa trong đoạn code bên dưới.

Nếu cần trợ giúp, hướng dẫn quickstart của chúng tôi có mọi thứ bạn cần để bắt đầu thuận lợi.

Các lĩnh vực khác nhau để đóng góp#

Sau khi thiết lập môi trường và làm quen với dự án, bạn có thể khám phá các lĩnh vực khác nhau mà mình có thể tạo ra tác động đáng kể. Ultralytics cung cấp nhiều cách để tham gia, và bạn có thể lựa chọn cách đóng góp dựa trên kỹ năng cũng như mối quan tâm của mình.

Dưới đây là một số lựa chọn:

• Tài liệu: Đóng góp cho tài liệu là một cách tuyệt vời để tìm hiểu sâu về dự án đồng thời rèn luyện kỹ năng viết. Bạn có thể giúp cải thiện tài liệu hiện có, bổ sung những chi tiết còn thiếu hoặc tạo các hướng dẫn mới giúp người khác đóng góp dễ dàng hơn.
• Sửa bug: Nếu có kinh nghiệm coding, hãy cân nhắc xử lý các bug. Công việc này có thể từ những điều chỉnh nhỏ đến các vấn đề phức tạp hơn, mang đến cho bạn cơ hội tạo ra tác động rõ rệt đến dự án.
• Cải tiến feature: Với những người sẵn sàng tìm hiểu sâu hơn, việc cải tiến feature có thể vừa thử thách vừa bổ ích. Công việc này có thể bao gồm việc bổ sung feature mới, cải thiện feature hiện có hoặc đóng góp vào roadmap của dự án.
• Review pull request: Review pull request là một cách đóng góp hữu ích khác, đặc biệt nếu bạn quen thuộc với các tiêu chuẩn và best practice của dự án. Bằng cách đưa ra feedback và đề xuất cải tiến, bạn giúp duy trì chất lượng cũng như tính toàn vẹn của codebase.
• Thảo luận cộng đồng: Tham gia các cuộc thảo luận cộng đồng là một cách đóng góp tuyệt vời nếu bạn yêu thích cộng tác và chia sẻ ý tưởng. Hãy tham gia các cuộc trò chuyện đang diễn ra, đề xuất ý tưởng mới hoặc giúp đỡ người khác bằng cách chia sẻ nhận định và giải pháp của bạn.

Mỗi lĩnh vực này mang đến một cách đóng góp riêng, và bạn có thể chọn lĩnh vực phù hợp nhất với thế mạnh cũng như mối quan tâm của mình. Hãy nhớ rằng mọi đóng góp, dù nhỏ đến đâu, đều đóng vai trò quan trọng trong việc giúp Ultralytics phát triển và tiến bộ.

Hình 2. Mọi đóng góp đều được trân trọng trong cộng đồng đang phát triển của chúng tôi. Nguồn hình ảnh: Envato Elements.

Đóng góp cho tài liệu mã nguồn mở của Ultralytics#

Khi đóng góp cho tài liệu Ultralytics, hãy nhớ review tài liệu hiện có và kiểm tra các issue hoặc cuộc thảo luận làm nổi bật những phần cần cải thiện. Việc này giúp đảm bảo đóng góp của bạn tập trung vào đúng nơi cần nhất.

Khi viết hoặc chỉnh sửa, hãy nhớ rằng việc tuân thủ hướng dẫn của dự án là yếu tố then chốt để duy trì tính nhất quán. Dưới đây là một số mẹo về formatting:

• Luôn sử dụng formatting Markdown.
• Bắt đầu mỗi tài liệu bằng phần giới thiệu rõ ràng và sử dụng ngôn ngữ đơn giản, dễ tiếp cận.
• Sử dụng danh sách bullet cho các danh sách, văn bản mô tả cho các liên kết và hình ảnh có dung lượng dưới 1 MB để trang tải nhanh.
• Nếu có câu hỏi về formatting, một cách đơn giản để kiểm tra lại là xem các tài liệu trước đây đã được format như thế nào.

Hình 3. Ví dụ về formatting Markdown (bên trái) và tài liệu được trực quan hóa hoàn chỉnh (bên phải). Hình ảnh của tác giả.

Sau khi hoàn thành bản nháp, bạn nên xem trước bằng cách build tài liệu trên máy local. Bạn có thể phát hiện mọi vấn đề trước khi gửi. Để thực hiện việc này, trước tiên hãy clone repository và chuyển đến thư mục dự án:

Tiếp theo, bạn có thể cài đặt các dependency cần thiết:

Cuối cùng, hãy serve tài liệu trên máy local để review các thay đổi:

Bạn có thể xem tài liệu được build trên máy local bằng cách truy cập http://127.0.0.1:8000/ trong trình duyệt web.

Sau khi review về độ rõ ràng, tính chính xác và nhất quán, bạn có thể gửi pull request kèm mô tả rõ ràng về tài liệu mình đã tạo. Hãy đặt tài liệu vào section phù hợp dựa trên vị trí và mục đích của tài liệu (guides, solutions, integrations, v.v.). Ngoài ra, hãy xem file index.md để kiểm tra các section liên quan và file mkdocs.yml tổng thể, đồng thời cập nhật khi cần. Sự chú ý đến từng chi tiết sẽ giúp quá trình review diễn ra suôn sẻ và đảm bảo đóng góp của bạn được tích hợp tốt vào dự án.

Những điều cần lưu ý khi đóng góp code mã nguồn mở#

Khi đóng góp code cho dự án Ultralytics, điều quan trọng là tuân thủ các best practice giúp đảm bảo code của bạn sạch, dễ bảo trì và dễ tích hợp. Dưới đây là một số điểm chính cần ghi nhớ:

• Tránh trùng lặp code: Tái sử dụng code hiện có bất cứ khi nào có thể và giảm thiểu các argument không cần thiết.
• Thực hiện các thay đổi nhỏ, tập trung: Tập trung vào những thay đổi nhỏ, có mục tiêu thay vì các sửa đổi lớn.
• Đơn giản hóa hoặc loại bỏ code: Tìm cơ hội để đơn giản hóa code hoặc loại bỏ những phần không cần thiết.
• Viết docstrings hiệu quả: Giải thích rõ code của bạn thực hiện những gì và liên kết đến các tài nguyên liên quan.
• Tránh dependency không cần thiết: Chỉ thêm dependency khi thực sự cần thiết.

Hình 4. Best practice về tài liệu source code.

Việc cân nhắc khả năng bảo trì codebase trong dài hạn cũng rất cần thiết. Trước khi thực hiện bất kỳ thay đổi nào, hãy tự hỏi liệu các sửa đổi của bạn có thể làm hỏng code hiện có của người khác đang sử dụng Ultralytics hay không. Nếu có, hãy cân nhắc cách xử lý và đảm bảo các thay đổi tương thích nhất có thể.

Sau khi phát triển một phần code để đóng góp, bạn cần kiểm thử phần code đó. Bạn có thể sử dụng các framework như pytest để kiểm thử các thay đổi trước khi gửi. Formatting code nhất quán cũng là một khía cạnh rất quan trọng trong đóng góp của bạn. Các công cụ như Ruff Formatter có thể giúp bạn duy trì tính nhất quán về style và phát hiện các bug logic hoặc điểm không nhất quán trong code.

Review pull request#

Review pull request (PR) là một cách tuyệt vời để đóng góp! PR được tạo khi ai đó yêu cầu merge các thay đổi của họ vào dự án chính. Việc này giúp dự án Ultralytics vận hành suôn sẻ. Khi review một PR, hãy đảm bảo bạn hiểu lý do thực hiện các thay đổi. Tác giả nên giải thích rõ mục đích và lợi ích của bản cập nhật, đồng thời PR cần có bằng chứng cho thấy đã được kiểm thử kỹ lưỡng.

Hình 5. Pull request là gì?

Hãy cùng xem qua một số điểm chính cần tập trung.

• Kiểm tra unit test: Kiểm tra PR có bao gồm test cho các feature mới hoặc thay đổi hay không để xác nhận code hoạt động như mong đợi và không gây ra vấn đề.
• Review các cập nhật tài liệu: Xác minh tài liệu đã được cập nhật để phản ánh các thay đổi hoặc feature mới, bao gồm ví dụ, tham chiếu API và các chi tiết liên quan khác.
• Đánh giá tác động đến hiệu năng: Cân nhắc những thay đổi ảnh hưởng đến hiệu năng như thế nào. Nếu cần, hãy yêu cầu benchmark hiệu năng hoặc kiểm thử bổ sung.
• Xác minh các test CI: Đảm bảo tất cả test Tích hợp liên tục (CI) đều vượt qua, bao gồm các bước kiểm tra formatting code và kết quả unit test.
• Cộng tác xử lý lỗi: Nếu có test thất bại, hãy phối hợp với tác giả để giải quyết vấn đề trước khi phê duyệt PR.

Với tư cách reviewer, hãy đảm bảo feedback của bạn cụ thể và làm rõ mọi vấn đề hoặc mối quan ngại. Đưa ra đề xuất cải thiện và đặt những câu hỏi giúp tác giả suy nghĩ thấu đáo về các vấn đề tiềm ẩn. Khuyến khích họ tuân thủ best practice trong coding, testing và viết tài liệu, đồng thời đừng ngần ngại hướng họ đến những tài nguyên hữu ích. Cuối cùng nhưng không kém phần quan trọng, hãy luôn ghi nhận nỗ lực mà tác giả đã dành cho PR. Feedback tích cực giúp duy trì bầu không khí thân thiện và cộng tác trong cộng đồng mã nguồn mở.

Đóng góp là vì cộng đồng#

Đóng góp cho các dự án mã nguồn mở như Ultralytics có thể mang đến cho bạn cảm giác cộng đồng đầy cảm hứng. Dù bạn viết code, review PR, cập nhật tài liệu hay tham gia thảo luận, mọi nỗ lực đều giúp dự án phát triển và tiến bộ. Trả lời issue hoặc tham gia trò chuyện trên GitHub, Discord, Subreddit hoặc các forum khác là một cách hữu ích để đóng góp và kết nối với mọi người. Hãy nhớ rằng những đóng góp của bạn, dù nhỏ đến đâu, đều tạo ra tác động đáng kể và góp phần xây dựng môi trường cộng tác, hỗ trợ cho tất cả mọi người tham gia!

Tại Ultralytics, chúng tôi đam mê thúc đẩy đổi mới trong cộng đồng mã nguồn mở. Hãy cập nhật những phát triển mới nhất của chúng tôi bằng cách truy cập repository GitHub. Tham gia cộng đồng sôi nổi của chúng tôi và xem cách chúng tôi tạo ra tác động trong các ngành như nông nghiệp và sản xuất.