Lompat ke konten utama
Logo Capgo

Kami menyambut dan menghargai semua kontribusi untuk Capgo.

Halaman ini berfungsi sebagai bantuan untuk memulai kontribusi.

Proyek

Ada banyak repositori di dalam 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 mungkin paling baik untuk memulai kontribusi (dan/atau sesuai dengan minat Anda), berikut adalah perbandingan singkat (<strong> bahasa pemrograman dalam tebal merupakan bagian terbesar dari kodebase </strong>):

Ini adalah repositori utama yang menyediakan Capgo

capacitor-updater

ini adalah repositori utama yang menyediakan capacitor-updater Plugin.

Anda ingin memperbaiki bug atau menambahkan fitur baru pada capacitor-updater? Repositori ini adalah tempat Anda ingin berkontribusi.

Bahasa: Swift, JavaScript, Java

capgo

Platform cloud Capgo yang terdiri dari aplikasi web dan fungsi serverless.

Bagikan tempat Anda ingin berkontribusi untuk memperbaiki backend Capgo.

Bahasa: TypeScript.

website

Frontend untuk halaman web resmi Deno: https://capgo.app/

Bahasa-bahasa: TypeScriptHTML, CSS

docs

Dokumentasi di Markdown yang menggerakkan https://docs.capgo.app

Bahasa-bahasa: Markdown

capacitor-standard-version

Manajer versi yang menggerakkan CI/CD untuk memperbarui aplikasi.

Bahasa-bahasa: JavaScript

  • Baca Pedoman gaya penulisan.

  • Tanyakan bantuan di ruang obrolan komunitas. Ketika Anda bekerja pada suatu masalah, sebutkan hal tersebut di komentar masalah sebelum Anda mulai bekerja pada masalah tersebut.

  • Ketika Anda bekerja pada fitur baru, buatlah masalah dan diskusikan dengan kontributor lain sebelum Anda mulai bekerja pada fitur tersebut; kami menghargai semua kontribusi, tetapi tidak semua fitur yang diajukan akan diterima. Kami tidak ingin Anda menghabiskan jam-jam bekerja pada __CAPGO_KEEP_0__ yang mungkin tidak diterima. Silakan profesional dalam forum. Kami mengikuti Rust's __CAPGO_KEEP_0__

  • (CoC). Memiliki masalah? Kirimkan email Kami mengikuti Pedoman Kode Etik Rust (CoC). you start working on the feature; we appreciate all contributions, but not all proposed features are getting accepted. We don't want you to spend hours working on a code that might not be accepted.

  • Kami mengikuti Pedoman Kode Etik Rust (CoC). Rust's code of conduct Kami mengikuti Pedoman Kode Etik Rust (CoC). ry@tinyclouds.org.

Mengirimkan permintaan pull

Sebelum mengirimkan PR ke salah satu repositori, pastikan hal-hal berikut telah dilakukan:

  1. Berikan judul PR yang deskriptif.

Contoh judul PR yang baik:

  • fix(std/http): Perbaiki kondisi balik dalam server
  • docs(console): Perbarui deskripsi dokumen
  • feat(doc): Tangani ekspor yang terikat

Contoh judul PR yang buruk:

  • fix #7123
  • perbarui dokumen

  • perbaiki bug

  • Pastikan ada masalah terkait dan itu disebutkan di teks PR.

  • Pastikan ada tes yang menutup perubahan.

Mengirimkan PR ke Capgo

Selain hal di atas, pastikan bahwa:

  1. bun run lint berhasil - ini akan memeriksa Rust dan JavaScript code untuk kesalahan umum dan kesalahan menggunakan Swiftlint (untuk Swift) dan eslint (untuk JavaScript dan Java)

Dokumentasi API

Penting untuk mendokumentasikan semua API publik dan kita ingin melakukannya secara langsung dengan code. Ini membantu memastikan code dan dokumentasi sangat terkait.

JavaScript dan TypeScript

Semua API dan tipe yang terbuka, modul harus memiliki dokumentasi JSDoc. Dokumentasi ini diparsing dan tersedia untuk kompilator TypeScript, dan oleh karena itu mudah untuk menyediakan lebih lanjut ke bawah. Blok JSDoc datang sebelum statement yang berlaku dan ditandai dengan tanda bintang di awal capacitor-updater Dokumentasi JSDoc harus ditambahkan sebelum statement yang berlaku dan ditandai dengan tanda bintang di awal /** sebelum berhenti dengan */. Contoh:

export const FOO = "foo";

Temukan lebih banyak di: https://jsdoc.app/