Lompat ke konten utama

We welcome and appreciate all contributions to Capgo.

Ini halaman membantu Anda memulai untuk berkontribusi.

Proyek

Ada banyak repositori di organisasi yang merupakan bagian dari ekosistem Capgo. Capgo organization that are part of the Capgo ecosystem.

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

Ini adalah repositori utama yang menyediakan Capgo

capacitor-updater

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

Kami menyambut dan menghargai semua kontribusi untuk Capgo. capacitor-updater? Anda ingin memperbaiki bug atau menambahkan fitur baru ke pengembang Capacitor Updater ini?

Bahasa: Swift, Pemrograman JavaScript, Pemrograman 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: Pemrograman 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 Aplikasi Terupdate

Bahasa: JavaScript

  • Baca Panduan gaya Panduan gaya

  • Tanyakan Bantuan di Ruang Obrolan Komunitas ruang percakapan komunitas.

  • Mentionkan isu tersebut sebelum bekerja pada isu tersebut. sebelum anda mulai bekerja pada isu tersebut.

  • Mentionkan isu tersebut sebelum bekerja pada fitur baru. 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.

  • Hargailah profesionalitas dalam forum. Kami mengikuti kode etik code Rust (CoC). Anda memiliki masalah? Kirim 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): Mengatasi kondisi balik dalam server
  • docs(console): Mengupdate string dokumen
  • feat(doc): Mengatasi ekspor yang terlapis

Contoh Judul PR yang Buruk:

  • fix #7123
  • Mengupdate dokumen
  • Mengatasi bug

  • Pastikan ada masalah terkait dan disebutkan dalam teks PR.

  • Pastikan ada tes yang menutup perubahan.

Mengirimkan PR ke Capgo

Mengingatkan bahwa:

  1. bun run lint Menggunakan perintah npm run lint - 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 kami ingin melakukannya secara langsung dengan code. Hal ini membantu memastikan bahwa code dan dokumentasi sangat terkait.

JavaScript dan TypeScript

Semua API dan jenis publik yang terbuka, 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 ditandai dengan tanda capacitor-updater sebelum berakhir dengan /** . Contoh: */ ]}

export const FOO = "foo";
        

Pencarian lebih lanjut di: https://jsdoc.app/