Hướng dẫn dự án

Cách nhận sao GitHub cho dự án mã nguồn mở

Để nhận sao GitHub, hãy giúp những lập trình viên phù hợp hiểu và dùng thử dự án, rồi cho họ lý do để lưu lại. Bắt đầu với một ví dụ chạy được và một cộng đồng liên quan. Sao có thể thể hiện sự quan tâm hoặc đóng vai trò dấu trang; chúng không cho biết có bao nhiêu người đang thực sự sử dụng phần mềm.

Ban biên tập GitHubStart · Cập nhật

Giúp lần ghé thăm kho mã đầu tiên trở nên hữu ích

Trước khi chia sẻ liên kết, hãy mở kho mã như một người chưa từng nghe về dự án. Màn hình đầu tiên nên giải thích vấn đề, người dùng mục tiêu và cách nhanh nhất để thấy kết quả. Ảnh chụp màn hình có thể hữu ích với công cụ trực quan; còn với thư viện, một ví dụ đầu vào/đầu ra ngắn thường có ích hơn.

Với một trình kiểm tra CSV giả định, câu “Kiểm tra tệp CSV xuất ra trước khi nhập vào cơ sở dữ liệu” cung cấp nhiều thông tin hơn “Bộ công cụ dữ liệu mạnh mẽ”. Tiếp theo, đưa ra một tệp mẫu không hợp lệ, lệnh kiểm tra và lỗi mà lệnh trả về.

  • Đặt mục đích và ví dụ chạy được trước danh sách tính năng dài.
  • Nêu yêu cầu môi trường chạy, các bước cài đặt và hạn chế đã biết.
  • Liên kết đến giấy phép, tài liệu và nơi báo lỗi.
  • Dùng chủ đề kho mã chính xác để người đang xem chủ đề đó tìm thấy dự án.

Tìm những độc giả phù hợp đầu tiên

Chọn cộng đồng nơi mọi người đã thảo luận về vấn đề bạn giải quyết. Công cụ dữ liệu Python cần cách giới thiệu khác với công cụ thiết kế trên trình duyệt. Giải thích một tình huống sử dụng cụ thể và điều bạn muốn nhận phản hồi. Nói rõ bạn là người duy trì dự án và đọc quy định đăng bài của cộng đồng trước.

Giữ thử nghiệm đầu tiên ở quy mô nhỏ: cải thiện README, chia sẻ một ví dụ chạy được tại một nơi phù hợp và trả lời các câu hỏi nhận được. Nếu độc giả không cài đặt được, hãy sửa trước khi mở thêm kênh. Đăng lặp lại cùng một liên kết không thay thế được việc giải quyết khó khăn khi bắt đầu sử dụng.

Mời gắn sao sau khi mang lại giá trị hữu ích

Một câu ngắn, tùy chọn sau phần bắt đầu nhanh là đủ: “Nếu dự án hữu ích với bạn, bạn có thể gắn sao kho mã để tìm lại sau này.” Hãy để mọi người tiếp cận hướng dẫn cài đặt, tài liệu và hỗ trợ dù họ có gắn sao hay không.

GitHubStart cung cấp danh mục khám phá và giao lưu công khai. Bạn có thể đăng kho mã công khai mà không cần đăng nhập GitHubStart, xem dự án khác và quyết định dự án nào muốn ủng hộ. Việc gắn sao vẫn được thực hiện thủ công khi đăng nhập GitHub. Đăng kho mã không hứa hẹn số sao cụ thể hay một lượt gắn sao đáp lại.

Ghi lại điều học được mỗi tuần

Ghi ngày, thay đổi đã thực hiện, nơi chia sẻ, câu hỏi nhận được và những gì đã sửa. So sánh sao với các tín hiệu thực tế như cài đặt thành công, lỗi có thể tái hiện và đóng góp lặp lại. Lượng sao tăng đột biến sau một bài đăng là mối tương quan, không phải bằng chứng rằng mọi sao mới đều đến từ bài đó.

Ví dụ: nếu năm độc giả hỏi cách cấu hình token, hãy chuyển hướng dẫn cấu hình lên trước ví dụ. Chia sẻ ví dụ đã sửa với những độc giả đó thay vì đăng thêm một thông báo ra mắt chung chung.

  • Tuần 1: kiểm chứng hướng dẫn bắt đầu nhanh trong môi trường sạch.
  • Tuần 2: chia sẻ một tình huống sử dụng và trả lời phản hồi.
  • Tuần 3: công bố các bản sửa và giải thích thay đổi.
  • Tuần 4: giữ kênh tạo ra trao đổi hữu ích và xem xét lại các kênh còn lại.

Câu hỏi thường gặp

Làm sao để có 100 sao GitHub đầu tiên?

Hãy xem 100 là một cột mốc, không phải kết quả được hứa hẹn. Bắt đầu với dự án dùng được, README rõ ràng và độc giả phù hợp. Các bước này vẫn áp dụng dù bạn có 5 hay 500 sao; thời gian cần thiết phụ thuộc vào đối tượng và dự án.

Có thể gắn sao kho mã GitHub mà không đăng nhập không?

Bạn có thể xem kho mã công khai và GitHubStart mà không cần tài khoản trang web. Để gắn sao, bạn phải tự đăng nhập GitHub. GitHubStart không thực hiện thao tác đó thay bạn.

Nhiều sao hơn có nghĩa là nhiều người dùng hơn không?

Không nhất thiết. Một người có thể lưu kho mã để xem sau mà không cài đặt. Theo dõi việc sử dụng và phản hồi riêng với số sao.

Tài liệu tham khảo