Selamat datang dan kami menghargai semua kontribusi untuk Capgo.
Halaman ini berfungsi sebagai bantuan untuk memulai berkontribusi.
Proyek
Ada banyak repositori di organisasi yang merupakan bagian dari ekosistem __CAPGO_KEEP_0__. Capgo organization that are part of the Capgo ecosystem.
Untuk membantu Anda memutuskan repositori mana yang paling baik untuk dimulai berkontribusi (dan/atau sesuai dengan minat Anda), berikut adalah perbandingan singkat (<strong> bahasa yang ditulis dalam tebal merupakan bahasa yang paling banyak digunakan </strong>):
Repositori utama yang menyediakan
Capgo
capacitor-updater
Plugin. capacitor-updater Jika Anda ingin memperbaiki bug atau menambahkan fitur baru ke
? Repositori ini adalah yang ingin Anda kontribusikan. capacitor-updaterBahasa:
context Swift, JavaScript, Java
capgo
The Webapp and serverless functions that make up the Capgo cloud platform.
Share where you want to contribute to fix the backend of Capgo.
Bahasa: TypeScript.
website
Frontend untuk halaman web resmi Deno: https://capgo.app/
Bahasa: TypeScript, HTML, CSS
docs
Dokumentasi dalam Markdown yang menggerakkan https://docs.capgo.app
Bahasa: Markdown
capacitor-standard-version
Pengelola Versi yang Membuat CI/CD Mengupdate Aplikasi
Bahasa: JavaScript
-
Baca panduan gaya Bantulah di ruang obrolan komunitas
-
Bantulah di ruang obrolan komunitas Sebutkan masalah saat bekerja di komentar masalah
-
Baca panduan gaya sebelumnya anda mulai bekerja pada masalah.
-
Ketika Anda bekerja pada fitur baru, buatlah masalah dan diskusikan dengan kontributor lain sebelumnya anda mulai bekerja pada fitur; kami menghargai semua kontribusi, tetapi tidak semua fitur yang diajukan diterima. Kami tidak ingin Anda menghabiskan jam-jam bekerja pada code yang mungkin tidak diterima.
-
Silakan profesional dalam forum. Kami mengikuti Rust's code kode etik (CoC). Anda memiliki masalah? Email ry@tinyclouds.org.
Mengirimkan permintaan pull
Sebelum mengirimkan PR ke salah satu repositori, silakan pastikan hal-hal berikut telah dilakukan:
- Berikan judul PR yang deskriptif.
Contoh judul PR yang baik:
- fix(std/http): Perbaiki kondisi balik dalam server
- docs(console): Perbarui dokumen string
- feat(doc): Tangani ekspor yang terikat
Contoh judul PR yang buruk:
- fix #7123
- perbarui dokumen
-
perbaiki bug
-
Pastikan ada masalah terkait dan disebutkan dalam teks PR.
- Pastikan ada tes yang menutup perubahan.
Mengirimkan PR ke Capgo
Selain hal di atas, pastikan bahwa:
bun run lintPasirin - ini akan memeriksa Rust dan JavaScript code untuk kesalahan dan kesalahan umum menggunakanSwiftlint(untuk Swift) daneslint(untuk JavaScript dan Java)
Dokumentasi API
Penting untuk mendokumentasikan semua API publik dan kami ingin melakukannya secara langsung dengan code. Ini membantu memastikan bahwa code dan dokumentasi sangat terkait.
JavaScript dan TypeScript
Semua API dan jenis yang terbuka, capacitor-updater modul harus memiliki dokumentasi JSDoc. Dokumentasi ini diproses dan tersedia untuk kompiler TypeScript, sehingga mudah untuk menyediakan lebih lanjut ke bawah aliran. Blok JSDoc datang sebelum statement yang berlaku dan dinyatakan oleh awalan /** sebelum berakhir dengan */. Contoh:
export const FOO = "foo";
Temukan lebih lanjut di: https://jsdoc.app/