Langsung ke konten utama

Kami menyambut dan menghargai semua kontribusi untuk Capgo.

Halaman ini berfungsi sebagai panduan untuk membantu Anda mulai berkontribusi.

Proyek

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

Setiap repository memiliki scope berbeda, menggunakan bahasa pemrograman yang berbeda, dan tingkat kontribusinya pun bervariasi.

Untuk membantu Anda memilih repository mana yang paling cocok untuk mulai berkontribusi (dan sesuai minat Anda), berikut perbandingannya (<strong> bahasa yang dicetak tebal mencakup sebagian besar codebase </strong>): Capgo

capacitor-updater

Ini adalah repository utama yang menyediakan capacitor-updater Plugin.

Anda ingin memperbaiki bug atau menambah fitur baru ke capacitor-updater? Inilah repository tempat Anda ingin berkontribusi.

Bahasa: Swift, JavaScript, Java

capgo

Webapp dan serverless functions yang membentuk platform cloud Capgo.

Beri tahu kami di mana 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 mendukung https://docs.capgo.app

Bahasa: Markdown

capacitor-standard-version

Version manager yang menggerakkan CI/CD untuk update aplikasi.

Bahasa: JavaScript

  • Baca panduan gaya.

  • Minta bantuan di chat room komunitas.

  • Saat mengerjakan sebuah issue, sebutkan hal itu di komentar issue sebelum saat Anda mulai mengerjakan issue tersebut.

  • Saat mengerjakan fitur baru, buatlah issue dan diskusikan dengan kontributor lain sebelum saat Anda mulai mengerjakan sebuah fitur; kami sangat menghargai semua kontribusi, namun tidak semua fitur yang diusulkan akan diterima. Kami tidak ingin Anda membuang waktu berjam-jam mengerjakan code yang mungkin tidak diterima.

  • Harap bersikap profesional di forum. Kami mengikuti code kode etik Rust (CoC). Ada masalah? Email ke ry@tinyclouds.org.

Mengirimkan pull request

Sebelum mengirimkan PR ke repo mana pun, pastikan hal-hal berikut sudah dilakukan:

  1. Berikan judul PR yang deskriptif.

Contoh judul PR yang baik:

  • fix(std/http): Perbaiki race condition pada server
  • docs(console): Perbarui docstrings
  • feat(doc): Tangani nested re-exports

Contoh judul PR yang buruk:

  • perbaiki #7123
  • update docs

  • perbaiki bug

  • Pastikan ada issue terkait dan sudah direferensikan di dalam teks PR.

  • Pastikan ada test yang mencakup perubahan tersebut.

Mengirimkan PR ke Capgo

Selain hal di atas, pastikan juga bahwa:

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

Dokumentasi API

Sangat penting untuk mendokumentasikan semua API publik dan kami ingin melakukannya selaras dengan code. Ini membantu memastikan code dan dokumentasi tetap terintegrasi erat.

JavaScript dan TypeScript

Semua API dan tipe yang terekspos secara publik, capacitor-updater modul harus memiliki dokumentasi JSDoc. Dokumentasi ini diparsing dan tersedia bagi compiler TypeScript, sehingga mudah untuk digunakan lebih lanjut. Blok JSDoc diletakkan tepat sebelum pernyataan terkait dan ditandai dengan /** sebelum diakhiri dengan */. Contohnya:

export const FOO = "foo";

Cari tahu lebih lanjut di: Pelajari lebih lanjut di https://jsdoc.app/