Nguyên tắc gửi sản phẩm công việc

Trong quá trình đánh giá cuối cùng, tất cả những người đóng góp tham gia phải cung cấp một đường liên kết đến phần việc họ đã làm trong chương trình. Nếu bạn không thực hiện đúng cách thì chương trình có thể không đạt được. Có nhiều cách để thực hiện việc này, vì vậy, vui lòng đọc kỹ tài liệu này.

Các đường liên kết này sẽ được phát hành trên bản lưu trữ công khai của các dự án GSoC. Những thành phần này giúp minh hoạ công việc đã thực hiện được trong chương trình. Đây cũng là cách tuyệt vời để bạn tham khảo lại công việc của mình cho các nhà tuyển dụng trong tương lai. Bạn muốn mọi người có thể nhanh chóng hiểu mục tiêu dự án của bạn là gì, bạn đã hoàn thành điều gì, mã của bạn ở đâu và bất kỳ bước tiềm năng nào tiếp theo.

Các ví dụ hay nhất mà chúng tôi thấy trong những năm qua là "báo cáo cuối cùng" bao gồm:

  • Nội dung mô tả ngắn về mục tiêu của dự án.
  • Các bạn đã làm được những gì!
  • Trạng thái hiện tại.
  • Việc còn lại cần làm.
  • Mã nào được hợp nhất (hoặc không) ngược dòng.
  • Bất kỳ thử thách nào hoặc những điều quan trọng bạn học được trong suốt dự án.

Để xem ví dụ, hãy bắt đầu từ Danh sách dự án năm 2022, chọn các dự án một cách ngẫu nhiên, sau đó nhấp vào XEM MÃ. Xin lưu ý rằng nhiều dự án trong số này đã không làm theo các đề xuất của chúng tôi, nghĩa là họ chỉ có khả năng thể hiện thành quả của mình.

LƯU Ý CHO NGƯỜI DÙNG: Sau khi gửi công việc cuối cùng mà bạn gửi, bạn có thể chỉnh sửa nội dung đó cho đến thời hạn gửi công việc cuối cùng.

Bạn nên chia sẻ đường liên kết của mình với người cố vấn TRƯỚC KHI gửi đánh giá để đảm bảo đánh giá đáp ứng kỳ vọng của họ.

Yêu cầu

  • Hệ thống phải dễ dàng nhận ra công việc bạn đã làm. (tức là những thay đổi bạn đã thực hiện hoặc mã mới.)
    • Khi ai đó truy cập URL được cung cấp, họ phải biết rõ công việc bạn đã làm mà không yêu cầu họ phải tìm hiểu thêm đáng kể.
  • Điện thoại phải ở vị trí ổn định. Bạn không thay đổi được URL sau khi gửi.
  • Người khác có thể sử dụng nội dung tại (hoặc được tham chiếu từ) mục tiêu của đường liên kết để mở rộng nội dung của bạn.
    • Nếu công việc của bạn đã hoàn thành 100%, họ sẽ có thể sử dụng công việc đó.
    • Nếu công việc của bạn chưa hoàn thành 100%, thì bạn nên biết rõ những việc cần làm.

Ví dụ hay

Bạn không cần phải làm tất cả (hoặc bất kỳ) việc nào trong số này, nhưng sau đây là một số cách bạn có thể đáp ứng các yêu cầu.

  • Tạo một bài đăng trên blog hoặc trang web hoặc nội dung chính trên GitHub công khai mô tả công việc bạn đã thực hiện và liên kết đến các cam kết bạn đã thực hiện và kho lưu trữ bạn đã làm. Nếu vẫn cần phải thực hiện công việc trên dự án, hãy thêm cả công việc đó. Bạn cũng có thể chia sẻ những khoảnh khắc nổi bật hoặc những chi tiết khó nhằn.
    • ❗ Đây là lựa chọn tốt nhất vì bạn có thể dễ dàng đưa nhiều thông tin vào. Điều này rất hữu ích vì mã này sẽ hiển thị rõ công việc bạn đã làm, cũng như giúp người khác dễ dàng sử dụng và hiểu mã của bạn.
  • Nếu sử dụng GitHub và tất cả công việc của bạn được thực hiện bằng một yêu cầu lấy dữ liệu duy nhất, thì bạn có thể sử dụng đường liên kết đó.
    • Hãy đảm bảo rằng nội dung mô tả của yêu cầu lấy dữ liệu được chi tiết. (Xem các đề xuất cho nội dung bài đăng trên blog ở trên.)
    • Hãy đảm bảo phần mô tả ghi chú rõ rằng đây là dành cho Google Summer of Code.
    • Nếu yêu cầu kéo sẽ có nhiều công việc được thực hiện hơn sau khi GSoC kết thúc, hãy nhớ ghi chú cam kết GSoC gần đây nhất.
    • ❗ Có một số lợi ích là có nhật ký thay đổi, danh sách cam kết và nhận xét đánh giá ở cùng một nơi.
  • Nếu kho lưu trữ GitHub của bạn là một mục đích duy nhất cho GSoC, hãy thêm README.md kèm theo nhiều thông tin chi tiết hơn.
  • Gửi email đến danh sách gửi thư của nhà phát triển được lưu trữ công khai (bao gồm cả những thông tin ở trên) và liên kết đến danh sách đó.
  • Tạo một thư mục công khai trong Google Drive và bao gồm tất cả bản vá bạn đã tạo.
  • Tạo một bảng tính công khai bằng Google Trang tính rồi liệt kê tất cả các thay đổi của bạn.
  • Đường liên kết đến một lỗi rõ ràng chứa tệp tham chiếu đến công việc đó và bất kỳ lỗi nào khác thích hợp. Nó sẽ theo dõi tất cả công việc bạn đã thực hiện. Hãy đảm bảo phần này liệt kê tất cả các thay đổi hoặc dễ tìm thấy các thay đổi đó.
  • Liên kết đến một điểm thống nhất hoặc khác biệt về ngữ cảnh của các thay đổi. Đừng quên thêm tiêu đề có ghi chú rõ dự án dành cho dự án nào và bạn là ai để mọi người cũng hữu ích.

Ví dụ không phù hợp

Đừng làm những việc này.

  • Liên kết đến một tệp tarball/zipfile chứa toàn bộ mã nguồn của dự án hoặc thư mục đang làm việc của bạn. (Quá nhiều người đã làm việc này trong quá khứ, nó không hữu ích đối với những người muốn hiểu thêm về những gì bạn đã làm.)
  • Liên kết đến đầu kho lưu trữ nguồn chính của dự án.
  • Liên kết đến bản sao của kho lưu trữ nguồn của dự án.
    • Điều này khiến bạn khó thấy được những thay đổi của mình vì công việc của bạn bị kết hợp với những người khác.
  • Đường liên kết đến trang dự án GSoC.
    • Chúng tôi đã biết điều đó. (ví dụ: https://summerofcode.withgoogle.com/projects/#1234567890)

Người cố vấn

Vui lòng giúp người đóng góp gửi mã thích hợp. Bạn cần phải thực hiện việc này trước giai đoạn gửi bài tập cuối cùng.

Hãy kiểm tra xem...

  • Nội dung bạn gửi đáp ứng các yêu cầu nêu trên.
  • Mã sẽ biên dịch.
  • Có tài liệu về nội dung và lý do.

Ý tưởng của GSoC không phải là người đóng góp rời bỏ mã. Điều quan trọng là mã này phải có tiềm năng hữu ích cho dự án Nguồn mở lưu trữ.