Kami menyambut dan menghargai semua kontribusi untuk Capgo.
Halaman ini berfungsi sebagai panduan untuk membantu Anda memulai berkontribusi.
Proyek
Ada banyak repositori di organisasi Capgo yang merupakan bagian dari Capgo.
Repositori memiliki cakupan yang berbeda, menggunakan bahasa pemrograman yang berbeda, dan memiliki tingkat yang bervariasi dalam hal kontribusi.
Untuk membantu Anda memutuskan repositori mana yang mungkin terbaik untuk mulai berkontribusi (dan/atau sesuai dengan minat Anda), berikut adalah perbandingan singkat (<strong> bahasa yang dicetak tebal mencakup sebagian besar kode sumber </strong>): Capgo
capacitor-updater
Ini adalah repositori utama yang menyediakan Plugin capacitor-updater.
Anda ingin memperbaiki bug atau menambahkan fitur baru ke capacitor-updater? Ini adalah repositori yang ingin Anda kontribusikan.
Languages: Swift, JavaScript, Java
capgo
Webapp dan fungsi tanpa server yang membentuk platform cloud Capgo.
Di mana Anda ingin berkontribusi untuk memperbaiki backend Capgo.
Languages: TypeScript.
website
Frontend untuk situs web resmi Deno: https://capgo.app/
Languages: TypeScript, HTML, CSS
docs
Dokumentasi dalam Markdown yang mendukung https://doc.capgo.app
Languages: Markdown
capacitor-standard-version
Manajer versi yang menggerakkan CI/CD untuk memperbarui aplikasi.
Languages: JavaScript
-
Baca panduan gaya.
-
Minta bantuan di ruang obrolan komunitas.
-
Saat Anda mengerjakan suatu masalah, sebutkan hal itu di komentar masalah sebelum Anda mulai mengerjakan masalah tersebut.
-
Ketika Anda mengerjakan fitur baru, buatlah sebuah isu dan diskusikan dengan kontributor lainnya sebelum Anda mulai mengerjakan fitur tersebut; kami menghargai semua kontribusi, tetapi tidak semua fitur yang diajukan diterima. Kami tidak ingin Anda menghabiskan berjam-jam mengerjakan kode yang mungkin tidak diterima.
-
Harap bersikap profesional di forum. Kami mengikuti kode etik Rust (CoC). Ada masalah? Kirim email ke ry@tinyclouds.org.
Mengajukan permintaan tarik
Sebelum mengajukan PR ke salah satu repos, pastikan yang berikut dilakukan:
- Berikan PR judul yang deskriptif.
Contoh judul PR yang baik:
- fix(std/http): Fix race condition in server
- docs(console): Update docstrings
- feat(doc): Handle nested re-exports
Contoh judul PR yang buruk:
- fix #7123
- update docs
-
fix bugs
-
Ensure there is a related issue and it is referenced in the PR text.
- Ensure there are tests that cover the changes.
Mengajukan PR ke Capgo
Selain itu, pastikan bahwa:
- `npm run lint` lulus - ini akan memeriksa kode Rust dan JavaScript untuk kesalahan dan kesalahan umum menggunakan `Swiftlint` (untuk Swift) dan `eslint` (untuk JavaScript dan Java)
Mendokumentasikan API
Penting untuk mendokumentasikan semua API publik dan kami ingin melakukannya secara langsung di dalam kode. Ini membantu memastikan bahwa kode dan dokumentasi terhubung erat satu sama lain.
JavaScript dan TypeScript
Semua API dan tipe yang diekspos secara publik, modul capacitor-updater harus memiliki dokumentasi JSDoc. Dokumentasi ini diparsing dan tersedia untuk kompiler TypeScript, sehingga mudah untuk diteruskan lebih lanjut. Blok JSDoc muncul tepat sebelum pernyataan yang mereka terapkan dan ditandai dengan /** sebelum diakhiri dengan */. Sebagai contoh:
export const FOO = "foo";
Temukan lebih banyak di: https://jsdoc.app/