Pedoman Pengiriman Produk Kerja

Sebagai bagian dari evaluasi akhir, semua kontributor yang berpartisipasi harus memberikan link ke pekerjaan yang telah mereka lakukan untuk program ini. Kegagalan untuk melakukannya dengan benar dapat mengakibatkan kegagalan program. Ada beberapa cara untuk melakukan ini, jadi harap baca dokumen ini dengan cermat.

Link ini akan dipublikasikan di arsip publik project GSoC. Mereka membantu mendemonstrasikan pekerjaan yang dilakukan selama program berlangsung. Ini juga merupakan cara yang bagus bagi Anda untuk merujuk kembali ke pekerjaan Anda untuk pemberi kerja di masa depan. Anda ingin agar orang-orang dapat dengan cepat memahami tujuan project, apa yang telah dicapai, di mana kode Anda, dan potensi langkah selanjutnya.

Contoh terbaik yang pernah kami lihat dalam beberapa tahun terakhir terlihat seperti "laporan akhir" yang berisi:

  • Deskripsi singkat tentang tujuan proyek.
  • Apa yang Anda lakukan.
  • Status saat ini.
  • Apa yang harus dilakukan.
  • Kode apa yang digabungkan (atau tidak) upstream.
  • Tantangan atau hal-hal penting apa pun yang Anda pelajari selama proyek berlangsung.

Untuk melihat contohnya, mulailah pada Daftar Project 2022, pilih project secara acak, lalu klik LIHAT KODE. Harap diperhatikan bahwa banyak project ini tidak mengikuti saran kami, yang berarti hanya membuat mereka terluka karena dapat memamerkan hasil kerja mereka.

CATATAN UNTUK KONTRIBUTOR: Setelah mengirimkan kiriman tugas akhir, Anda dapat mengeditnya hingga batas waktu pengiriman tugas akhir.

Anda harus membagikan tautan dengan mentor Anda SEBELUM mengirimkan evaluasi untuk memastikan tautan memenuhi harapan mereka.

Persyaratan

  • Pekerjaan yang telah Anda lakukan harus mudah diidentifikasi. (yaitu perubahan yang Anda buat atau kode baru.)
    • Saat seseorang membuka URL yang diberikan, pekerjaan apa saja yang telah Anda lakukan sudah jelas tanpa mengharuskannya melakukan penggalian tambahan yang signifikan.
  • File harus berada di lokasi yang stabil. URL tidak dapat diubah setelah pengiriman.
  • Orang lain harus dapat menggunakan konten di (atau mereferensikan dari) target link untuk memperluas pekerjaan Anda.
    • Jika pekerjaan Anda 100% selesai, mereka seharusnya dapat menggunakannya.
    • Jika pekerjaan Anda belum 100% selesai, sudah jelas apa yang harus dilakukan.

Contoh yang Baik

Anda tidak harus melakukan semua (atau sebagian) hal tersebut, tetapi ada beberapa cara yang dapat memenuhi persyaratan ini.

  • Buat postingan blog atau halaman web atau inti GitHub publik yang menjelaskan pekerjaan yang telah Anda lakukan dan link ke commit yang telah Anda buat dan repositori yang telah Anda kerjakan. Jika masih ada pekerjaan yang harus dilakukan pada proyek, sertakan juga pekerjaan tersebut. Anda juga dapat membagikan sorotan atau bagian yang menantang.
    • ❗ Ini adalah opsi terbaik karena memungkinkan Anda untuk menyertakan banyak informasi dengan mudah. Hal ini bagus karena akan dengan jelas menunjukkan pekerjaan apa yang Anda lakukan, serta memudahkan orang lain untuk menggunakan dan memahami kode Anda.
  • Jika menggunakan GitHub, dan semua pekerjaan dicakup oleh satu permintaan pull, Anda dapat menggunakan link tersebut.
    • Pastikan deskripsi permintaan pull mendetail. (Lihat saran untuk konten postingan blog di atas.)
    • Pastikan deskripsi menyatakan dengan jelas bahwa ini adalah untuk Google Summer of Code.
    • Jika permintaan pull akan memiliki lebih banyak pekerjaan yang dilakukan setelah GSoC berakhir, pastikan commit GSoC terakhir dicatat.
    • ❗ Contoh ini memiliki manfaat berupa log perubahan, daftar commit, dan komentar ulasan, semuanya di satu tempat.
  • Jika repositori GitHub Anda memiliki satu tujuan untuk GSoC, tambahkan README.md dengan lebih detail.
  • Kirim email ke milis developer yang diarsipkan secara publik, beserta contoh di atas, dan tautkan juga ke milis tersebut.
  • Buat folder publik di Google Drive dan sertakan semua patch yang telah Anda buat.
  • Buat spreadsheet publik dengan Google Spreadsheet dan cantumkan semua commit Anda.
  • Tautkan ke satu bug yang dengan jelas berisi referensi ke pekerjaan dan hal lain yang sesuai. Aplikasi ini akan melacak semua pekerjaan yang telah Anda lakukan. Pastikan semuanya mencantumkan semua commit atau commit sehingga mudah ditemukan.
  • Tautkan ke perbedaan konteks atau terpadu dari perubahan Anda. Pastikan untuk menyertakan {i>header<i} yang mencatat proyek apa dan siapa Anda, sehingga {i>header<i} dapat berguna bagi orang lain.

Contoh Buruk

Jangan lakukan hal-hal ini.

  • Tautkan ke tarball/zipfile yang berisi seluruh kode sumber project atau direktori kerja Anda. (Terlalu banyak orang yang sudah pernah melakukan hal ini. Oleh karena itu, tidak berguna bagi orang yang ingin lebih memahami hal yang dilakukan Anda.)
  • Tautkan ke bagian atas repositori sumber utama project.
  • Tautkan ke clone repositori sumber project Anda.
    • Hal ini menyulitkan untuk melihat perubahan yang Anda buat karena karya Anda dicampur dengan orang lain.
  • Link ke halaman project GSoC Anda.
    • Kita sudah mengetahui fungsi tersebut. (yaitu https://summerofcode.withgoogle.com/projects/#1234567890)

Mentor

Bantu kontributor Anda melakukan pengiriman kode dengan benar. Penting untuk melakukannya sebelum periode pengiriman tugas akhir.

Periksa apakah...

  • Kiriman memenuhi persyaratan di atas.
  • Kode akan dikompilasi.
  • Ada dokumentasi tentang apa dan mengapa.

Gagasan tentang GSoC bukanlah bahwa kontributor melakukan churn out, tetapi yang terpenting adalah kode tersebut berpotensi berguna bagi project Open Source hosting.