Lompat ke konten utama
Logo Capgo

Kami menyambut dan menghargai semua kontribusi untuk Capgo.

Halaman ini berfungsi sebagai bantuan untuk memulai berkontribusi.

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 dimulai berkontribusi (dan/atau sesuai dengan minat Anda), berikut adalah perbandingan singkat (<strong> bahasa pemrograman dalam tebal merupakan inti kodebase </strong>):

Ini adalah repositori utama yang menyediakan Capgo

capacitor-updater

Plugin. capacitor-updater Anda ingin memperbaiki bug atau menambahkan fitur baru ke

? Repositori ini adalah yang ingin Anda kontribusikan. capacitor-updaterBahasa Pemrograman:

__CAPGO_KEEP_0__ Bahasa Pemrograman, JavaScript, Java

capgo

Platform awan 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, CSS

docs

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

Bahasa: Markdown

capacitor-standard-version

Manajer Versi yang menggerakkan CI/CD untuk memperbarui aplikasi.

Bahasa: JavaScript

  • Baca style guide.

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

  • Ketika Anda bekerja pada masalah, sebutkan hal tersebut di komentar masalah. sebelum anda mulai bekerja pada masalah.

  • Ketika Anda bekerja pada fitur baru, buatlah masalah dan diskusikan dengan kontributor lain sebelum anda mulai bekerja pada fitur; kami menghargai semua kontribusi, tetapi tidak semua fitur yang diajukan diterima. Kami tidak ingin Anda menghabiskan jam berjam bekerja pada code yang mungkin tidak diterima.

  • Silakan profesional dalam forum. Kami mengikuti Rust's code kode etik (CoC). Punya 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:

  • 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 disebutkan dalam teks PR.

  • Pastikan ada tes yang menutup perubahan.

Mengirimkan PR ke Capgo

Selain di atas, pastikan:

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

Mendokumentasikan 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 diproses dan tersedia untuk kompilator TypeScript, sehingga mudah untuk menyediakan lebih lanjut secara downstream. Blok JSDoc datang sebelum statement yang mereka aplikasikan dan diidentifikasi oleh tanda bintang (*) capacitor-updater sebelum berakhir dengan /** . Contoh: */Cari lebih banyak di:

export const FOO = "foo";

https://jsdoc.app/ Find more at: https://jsdoc.app/