Lebih cepat ke konten utama
Logo Capgo

Kami menyambut dan menghargai semua kontribusi ke Capgo.

Halaman ini berfungsi sebagai bantuan untuk memulai berkontribusi.

Proyek

Ada banyak repositori di dalam Capgo organisasi yang merupakan bagian dari ekosistem Capgo.

Repositori memiliki skop yang berbeda, menggunakan bahasa pemrograman yang berbeda dan memiliki tingkat kontribusi yang berbeda.

Untuk membantu Anda memutuskan repositori mana yang mungkin paling baik untuk dimulai berkontribusi (dan/atau sesuai dengan minat Anda), berikut adalah perbandingan singkat (<strong> bahasa pemrograman yang ditulis dalam tebal merupakan bagian besar dari kodebase </strong>): Capgo

capacitor-updater

Ini adalah repositori utama yang menyediakan capacitor-updater Plugin.

Anda ingin memperbaiki bug atau menambahkan fitur baru ke capacitor-updater? Ini adalah repositori yang Anda ingin berkontribusi.

Bahasa Pemrograman: Swift, JavaScript, Java

capgo

Platform cloud Capgo yang terdiri dari aplikasi web dan fungsi tanpa server.

Bagikan tempat Anda ingin berkontribusi untuk memperbaiki backend Capgo.

Bahasa: TypeScript.

website

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

Bahasa: TypeScript, HTML, CSSDokumentasi dalam Markdown yang menggerakkan

docs

Documentation in Markdown yang menggerakkan https://docs.capgo.app

Bahasa-bahasa: Markdown

capacitor-standard-version

Manajer Versi yang Membuat CI/CD untuk Mengupdate Aplikasi.

Bahasa-bahasa: JavaScript

  • Baca panduan gaya. Tanyakan bantuan di ruang obrolan komunitas.

  • Ketika Anda bekerja pada masalah, sebutkan di komentar masalah sebelumnya. https://docs.__CAPGO_KEEP_0__.app

  • Bahasa-bahasa: Markdown Anda mulai bekerja pada masalah.

  • Ketika Anda bekerja pada fitur baru, buatlah masalah dan diskusikan dengan kontributor lain. sebelum Sebelum 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 dari kode etik (CoC). Anda memiliki masalah? Email 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:

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

Contoh judul PR yang buruk:

  • perbaiki #7123
  • perbarui dokumen

  • perbaiki bug

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

  • Pastikan ada tes yang menutup perubahan.

Mengirimkan PR ke Capgo

Selain 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)

Mendokumentasikan API

Penting untuk mendokumentasikan semua API publik dan kami ingin melakukannya secara langsung dengan code. Hal ini membantu memastikan bahwa code dan dokumentasi sangat terkait.

JavaScript dan TypeScript

Semua API dan jenis yang terbuka, modul harus memiliki dokumentasi JSDoc. Dokumentasi ini diproses dan tersedia untuk kompilator TypeScript, sehingga mudah untuk menyediakan lebih lanjut. Blok JSDoc datang sebelum statement yang berlaku dan diidentifikasi oleh tanda bintang di awal sebelum berakhir dengan tanda titik dua. capacitor-updater Contoh: /** Temukan lebih banyak di: */https://jsdoc.app/

export const FOO = "foo";

Footer Find more at: