Lompat ke konten utama
Capgo logo

Kami menyambut dan menghargai semua kontribusi untuk Capgo.

Halaman ini berfungsi sebagai bantuan untuk memulai kontribusi.

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 memulai kontribusi (dan/atau sesuai dengan minat Anda), berikut adalah perbandingan singkat (<strong> bahasa pemrograman dalam tebal merupakan bagian terbesar dari kodebase </strong>): Capgo

capacitor-updater

Repositori utama yang menyediakan __CAPGO_KEEP_0__. capacitor-updater Plugin.

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

Bahasa: Swift, JavaScript, Platform cloud __CAPGO_KEEP_0__ yang terdiri dari aplikasi web dan fungsi serverless.

capgo

Bagikan tempat Anda ingin berkontribusi untuk memperbaiki backend Capgo.

Share where you want to contribute to fix the backend of Capgo.

TypeScript Frontend untuk halaman web resmi Deno: .

website

__CAPGO_KEEP_0__ https://capgo.app/

Bahasa-bahasa: TypeScript, HTML, CSS

docs

Dokumentasi dalam 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 Petunjuk gaya penulisan.

  • Tanyakan bantuan di ruang obrolan komunitas.

  • Saat Anda bekerja pada suatu masalah, sebutkan hal tersebut di komentar masalah sebelum Anda mulai bekerja pada masalah tersebut.

  • Saat 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 diterima. Kami tidak ingin Anda menghabiskan jam berjam bekerja pada code yang mungkin tidak diterima.

  • Silakan bersikap profesional di forum. Kami mengikuti Rust's code kode etik (CoC). Mengalami masalah? Kirim email ry@tinyclouds.org.

Mengirimkan permintaan pull

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

  1. Berikan judul permintaan pull yang deskriptif.

Contoh judul permintaan pull yang baik:

  • fix(std/http): Mengatasi kondisi balik dalam server
  • docs(console): Mengupdate dokumen string
  • feat(doc): Mengatasi ekspor yang terikat

Contoh judul permintaan pull yang buruk:

  • fix #7123
  • update dokumen

  • mengatasi bug

  • Pastikan ada masalah terkait dan itu disebutkan dalam 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)

Documentasi 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 jenis yang terbuka, modul harus memiliki dokumentasi JSDoc. Dokumentasi ini diproses dan tersedia untuk kompilator TypeScript, dan oleh karena itu mudah untuk menyediakan lebih lanjut ke bawah aliran. Blok JSDoc datang sebelum statement yang berlaku dan ditandai dengan tanda bintang di awal capacitor-updater JSDoc blocks datang 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/