Mengirim permintaan tarik
Peringatan
This documentation refers to an outdated SpongeAPI version and is no longer actively maintained. While the code examples still work for that API version, the policies, guidelines, and some links may have changed. Please refer to the latest version of the documentation for those.
Dasar
Pertama anda perlu menyetup mesin anda agar bisa berkembang dan dengan sponge:
baca :doc:' /menyiapkan/indeks' dan atur mesin kamu
dapatkan keakraban dengan git dan GitHub: :doc:' ../howtogit '
baca kami :doc:' Jenis kode halaman <codestyle>' dan :doc:' ../guidelines'
dapatkan keakraban dengan kami :doc:' git-implementation'
Setelah selesai dan merasa siap untuk mengembangkan sponge, putuskan bagian mana yang ingin anda kerjakan.
Menulis sebuah PR
Memperbaiki bugs
Jelaskan dalam beberapa kalimat:
bugs mana yang kamu temui, terutana
bagaimana berperilaku
bagaimana menurut anda seharusnya berperilaku
apa yang anda perbaiki
bagaimana anda memperbaikinya
Penambahan API Utama
Jadi, anda telah mengembangkan cukup besar API tambahan yang anda inginkan untuk sekarang menyerahkan sebagai PR. Baik! Konstruktif PR ini adalah apa yang membuat proyek ini terus mendapatkan yang lebih baik. Yang membawa kita untuk menulis mulia PR keterangan.
Ada beberapa di masa lalu yang melampaui standar, contohnya meliputi:
' Inventaris API PR <https://github.com/SpongePowered/SpongeAPI/pull/443>'_
' Data API PR <https://github.com/SpongePowered/SpongeAPI/pull/542>'_
Tentu saja, contoh-contoh yang ekstrim, tapi PR yang diterima dan memberikan standar yang baik dari apa yang harus dimasukkan dalam PR deskripsi adalah:
' Acara Penyaringan PR <https://github.com/SpongePowered/SpongeAPI/pull/927>'_
' Larangan perbaikan API PR <https://github.com/SpongePowered/SpongeAPI/pull/954> '_
Beberapa hal yang bisa diambil dari sini:
Link ke setiap pelaksanaan PRs dalam pandangan yang jelas di bagian atas PR, hal ini dapat dicapai dengan GitHub Penurunan harga
*SpongeAPI*|[SpongeCommon](html link)|[SpongeForge](html link)|[SpongeVanilla](html link)
Gambaran yang jelas dari apa yang API PR bertujuan untuk melakukan, ini bisa menjadi ringkas seolah-olah menulis esai, paling banyak 4 kalimat panjang, tergantung pada apa fungsi.
Hapus contoh kode bagaimana plugin bisa memakai fitur baru (dan jika fitur lama ada, kenapa fitur tersebut harus diubah).