Halaman ini terakhir diperbarui pada s2020-05.

Pertama-tama, baca panduan pengembang baru.

Dasar Panduan Pengembang dan Gaya Coding

Sebagian besar hal berikut seharusnya panduan umum bagi siapa saja yang telah mengerjakan open source atau dalam lingkungan pemrograman komersial. Berikut ini berlaku terutama untuk cabang pengembangan utama i2p.i2p. Pedoman untuk cabang-cabang lain, plugin, dan aplikasi eksternal mungkin secara substansial berbeda; periksa dengan pengembang yang bersangkutan untuk panduan.

Komunitas

  • Please don't just "write code". If you can, participate in other development activities, including: development discussions and support on IRC, zzz.i2p, and i2pforum.i2p; testing; bug reporting and responses; documentation; code reviews; etc.
  • Pengembang aktif harus bisa dihubungi secara berkala di IRC #i2p-dev. Hati-hati dengan siklus rilis saat ini. Patuhi milestone rilis seperti feature freeze, tag freeze, dan checkin deadline untuk rilis.

Siklus Rilis

Our normal release cycle is 6-12 weeks. Following are the approximate deadlines within a typical 8-week cycle. Actual deadlines for each release are set by the lead developer after consultation with the full team.

  • 1-2 hari setelah rilis sebelumnya: Checkins ke trunk diperbolehkan.
  • 2-3 minggu setelah rilis sebelumnya: tenggat waktu untuk menyebarkan perubahan besar dari cabang lainnya ke trunk.
  • 4-5 minggu sebelum rilis: tenggat waktu untuk permintaan link ke home page baru.
  • 3-4 minggu sebelum rilis: fitur dibekukan. Batas waktu untuk fitur baru.
  • 2-3 minggu sebelum rilis: mengadakan rapat proyek untuk meninjau permintaan link home page baru, jika ada.
  • 10-14 days before release: String freeze. No more changes to translated ("tagged") strings. Push strings to Transifex, announce translation deadline on Transifex.
  • 10-14 days before release: Feature deadline. Bug fixes only after this time. No more features, refactoring or cleanup.
  • 3-4 days before release: Translation deadline. Pull translations from Transifex and check in.
  • 3-4 days before release: Checkin deadline. No checkins after this time without the permission of the release builder.
  • Beberapa jam sebelum rilis: tenggang review kode.

Monotone

  • Memiliki pemahaman dasar tentang sistem kontrol kode sumber terdistribusi, bahkan jika anda belum menggunakan Monotone sebelumnya. Ajukan pertanyaan jika diperlukan Setelah didorong, checkin berlaku selamanya, tidak ada revisi. Harap berhati-hati. Jika anda belum pernah menggunakan monotone sebelumnya, mulailah dengan langkah-langkah kecil. Check-in beberapa perubahan kecil dan lihat bagaimana kelanjutannya.
  • Uji perubahan sebelum melakukan checkin. Jika Anda memilih model pengembangan checkin-sebelum-test, gunakan cabang pengembangan anda sendiri (misalnya i2p.i2p.yourname.test) dan sebarkan kembali ke i2p.i2p setelah itu bekerja dengan baik. Jangan rusak build yang sudah ada Jangan membuat regressions. Jika anda melakukan hal ini (sudah terjadi), harap anda jangan kabur untuk jangka waktu yang lama setelah anda mendorong perubahan anda.
  • Jika perubahan anda non-trivial, atau anda ingin orang lain mengujinya dan perlu laporan tes yang bagus untuk mengetahui apakah perubahan anda sudah diuji atau tidak, tambahkan komentar checkin ke history.txt dan buat build revision di RouterVersion.java.
  • Pastikan bahwa anda memiliki file monotonerc yang terbaru di _MTN. Jangan check-in di atas revisi tidak terpercaya.
  • Pastikan anda melakukan 'mnt pull' 'dan 'mtn update' ke revisi terbaru sebelum anda check in dan push. Jika Anda secara tidak sengaja menyimpang, gabungkan dan dorong sesegera mungkin. Jangan sering-sering membuat orang lain menggabungkannya untuk anda. Ya, kami tahu bahwa monotone bilang bahwa anda harus mendorong dan kemudian menggabungkan, tetapi dalam pengalaman kami, penggabungan in-workspace bekerja dengan baik seperti penggabungan dalam database, tanpa membuat revisi penggabungan.
  • Jangan checkin perubahan besar ke dalam cabang utama i2p.i2p di akhir siklus rilis. Jika sebuah proyek memerlukan waktu lebih dari beberapa hari, buat cabang sendiri di monotone dan lakukan pengembangan di sana sehingga anda tidak memblokir rilis.

Gaya Pengkodean

  • Gaya Pengkodean sepanjang sebagian besar kode adalah 4-spasi untuk indentasi. Jangan gunakan tab. Jangan memformat-ulang kode Jika IDE atau editor anda ingin memformat ulang semuanya, kendalikan itu. Ya, kami tahu 4 spasi tidak enak dilakukan, tapi mungkin anda dapat mengkonfigurasi editor anda. Di beberapa tempat, gaya pengkodean berbeda. Gunakan akal sehat. Ikuti gaya ini dalam file yang anda memodifikasi.
  • Semua kelas umum dan paket-pribadi yang baru dan metode memerlukan Javadocs. Tambahkan @since nomor rilis. Javadocs untuk metode privaye baru lebih disukai.
  • For any Javadocs added, there must not be any doclint errors or warnings. Run 'ant javadoc' with Oracle Java 14 or higher to check. All params must have @param lines, all non-void methods must have @return lines, all exceptions declared thrown must have @throws lines, and no HTML errors.
  • Class di core / (i2p.jar) dan beberapa bagian dari i2ptunnel merupakan bagian dari API resmi kami. Ada beberapa plugin out-of-tree dan aplikasi lainnya yang mengandalkan API ini. Berhati-hatilah untuk tidak membuat perubahan yang merusak kompatibilitas. Jangan menambahkan metode ke API kecuali mereka memiliki utilitas umum. Javadocs untuk metode API harus jelas dan lengkap. Jika anda menambahkan atau mengubah API, juga memperbarui dokumentasi pada website (cabang i2p.www).
  • Beri tag kepada string untuk terjemahan di mana tepat. Jangan mengubah string tagged yang ada kecuali benar-benar diperlukan, karena itu akan merusak terjemahan yang ada. Jangan menambahkan atau mengubah tagged string setelah "freeze tag" di siklus rilis sehingga penerjemah memiliki kesempatan untuk memperbarui terjemahan sebelum rilis.
  • Gunakan generik dan concurrent class di mana mungkin digunakan. I2p adalah sebuah aplikasi yang sangat multi-thread.
  • Kenali common pitfalls Java yang tertangkap oleh findbugs. Jlankan 'ant findbugs' untuk mempelajari lebih lanjut.
  • We require Java 8 to build and run I2P as of release 0.9.47. Do not use Java 7 or 8 classes or methods in embedded subsystems: addressbook, core, i2ptunnel.jar (non-UI), mstreaming, router, routerconsole (news only), streaming. These subsystems are used by Android and embedded applications that require only Java 6. All classes must be available in Android API 14. Java 7 language features are acceptable in these subsystems if supported by the current version of the Android SDK and they compile to Java 6-compatible code.
  • Try-with-resources cannot be used in embedded subsystems as it requires java.lang.AutoCloseable in the runtime, and this is not available until Android API 19 (KitKat 4.4).
  • The java.nio.file package cannot be used in embedded subsystems as it is not available until Android API 26 (Oreo 8).
  • Other than the above limitations, Java 8 classes, methods, and constructs may be used in the following subsystems only: BOB, desktopgui, i2psnark, i2ptunnel.war (UI), jetty-i2p.jar, jsonrpc, routerconsole (except news), SAM, susidns, susimail, systray.
  • Plugin authors may require any minimum Java version via the plugin.config file.
  • Secara eksplisit mengkonversi antara tipe primitif dan kelas; jangan bergantung pada autoboxing/unboxing.
  • Jangan gunakan URL. Gunakan URI.
  • Tidak menangkap Exceptions. Tangkap RuntimeException dan exception diperiksa secara satu per satu.
  • Jangan gunakan String.getBytes() tanpa argumen charset UTF-8. Anda juga dapat menggunakan DataHelper.getUTF8() atau DataHelper.getASCII().
  • Selalu menentukan charset UTF-8 saat membaca atau menulis file. Utility DataHelper dapat membantu.
  • Selalu tentukan locale (misalnya Locale.US) ketika menggunakan String.toLowerCase() atau String.toUpperCase(). Jangan gunakan String.equalsIgnoreCase(), karena locale tidak bisa dispesifikasikan.
  • Jangan gunakan String.split(). Gunakan DataHelper.split().
  • Don't add code to format dates and times. Use DataHelper.formatDate() and formatTime().
  • Pastikan bahwa InputStreams dan OutputStreams ditutup dalam finally blocks.
  • Gunakan {} untuk semua untuk dan while block, bahkan jika hanya satu baris. Jika anda menggunakan {} untuk blok if, else,atau if-else, gunakannya untuk semua blok. tempatkan "} else {" pada satu baris.
  • tentukan field sebagai final sedapat mungkin.
  • Jangan simpan I2PAppContext, RouterContext, Log, atau referensi lain untuk router atau konteks item di static fields.
  • Jangan mulai threads di dalam constructors. Gunakan I2PAppThread, jangan Thread.

Lisensi

  • Hanya periksa kode yang anda tulis sendiri. Sebelum check in kode atau library jar dari sumber lain, periksa apakah mereka diperlukan, verifikasi lisensi kompatibel, dan dapatkan persetujuan dari pengembang utama.
  • Jika anda memperoleh persetujuan untuk menambahkan kode eksternal atau jar, dan binari tersedia dalam paket Debian atau Ubuntu, anda harus menerapkan opsi build dan packaging dengan menggunakan paket eksternal sebagai gantinya. Daftar Periksa file untuk modifikasi: build.properties, build.xml, debian/control, debian/i2p-router.install, debian/i2p-router.links, debian/rules, sub-build.xml
  • Setiap gambar yang diperiksa dari sumber eksternal, adalah tanggung jawab anda untuk pertama-tama memverifikasi lisensi apakah kompatibel. Termasuk informasi lisensi dan sumber dalam komentar Check-in.

Bug

  • Mengelola Trac tickets adalah tanggung-jawab semua orang, mohon bantuannya. Pantau trac.i2p2.de untuk tiket yang menjadi tanggung-jawab anda atau yang dapat anda bantu. Delegasi, kategorisasi, beri komentar, perbaiki atau tutup tiket, jika anda dapat melakukannya.
  • Pengembang baru harus mulai dengan memperbaiki bug. Cari bug dengan kata kunci 'mudah' di trac. Bila anda sudah memiliki perbaikan, lampirkan patch anda ke tiket dan tambahkan kata kunci 'review-needed'. Jangan tutup tiket telah berhasil ditinjau dan anda sudah memeriksa perubahan. Setelah anda melakukan ini dengan lancar selama dua tiket, anda dapat mengikuti prosedur normal di bawah ini.
  • Tutup tiket ketika menurut anda bug sudah diperbaiki. Kami tidak memiliki departemen tes untuk memverifikasi dan menutup tiket. Jika anda tidak yakin anda telah memperbaiki sebuah bug, tutup dan tambahkan catatan: "Saya pikir saya telah memperbaikinya, silahkan uji dan buka kembali jika bug masih ada". Tambahkan komentar dengan nomor dev atau nomor revisi dan tetapkan milestone untuk rilis berikutnya.