Skip to main content

Berkontribusi Untuk SubQuery

SubQuery TeamAbout 1 min

Berkontribusi Untuk SubQuery

Selamat datang dan terima kasih banyak telah mempertimbangkan untuk berkontribusi pada proyek SubQuery ini! Bersama-sama kita dapat membuka jalan menuju masa depan yang lebih terdesentralisasi.

Catatan Dokumentasi ini secara aktif dikelola oleh tim SubQuery. Kami juga menerima kontribusi. Anda dapat melakukannya dengan melakukan forking proyek GitHub kami dan membuat perubahan pada semua file markdown dokumentasi di bawah direktori `docs`. :::

Berikut ini adalah seperangkat pedoman (bukan aturan) untuk berkontribusi pada SubQuery. Mengikuti panduan ini akan membantu kami membuat proses kontribusi menjadi mudah dan efektif untuk semua orang yang terlibat. Ini juga menyampaikan bahwa Anda setuju untuk menghormati waktu dari developer yang mengelola dan mengembangkan proyek ini. Sebagai imbalannya, kami akan membalas rasa hormat itu dengan mengatasi masalah Anda, mempertimbangkan perubahan, berkolaborasi dalam peningkatan, dan membantu Anda menyelesaikan pull request Anda.

Kode Etik

Kami menganggap serius proyek dan tanggung jawab komunitas open source kami dan menjaga diri kami dan kontributor lain pada standar komunikasi yang tinggi. Dengan berpartisipasi dan berkontribusi pada proyek ini, Anda setuju untuk menjunjung Kode Etikopen in new window kami.

Memulai

Kontribusi ke repositori kami dilakukan melalui Issue and Pull Request (PR). Beberapa pedoman umum yang mencakup keduanya:

  • Cari Issue and PR yang ada terlebih dahulu sebelum membuat milik Anda sendiri.
  • Kami bekerja keras untuk memastikan issue ditangani dengan segera, tetapi tergantung pada dampaknya, mungkin bisa memakan waktu cukup lama untuk menyelidiki akar masalahnya. Sebuah @ sebutan ramah di utas komentar kepada pengirim atau kontributor dapat membantu menarik perhatian jika issue Anda terblokir.

Bagaimana Berkontribusi

Melaporkan Bug

Bug dilacak sebagai issue GitHub. Saat mencatatkan log issue, jelaskan masalahnya dan sertakan detail tambahan untuk membantu pengelola mereproduksi masalah itu:

  • Gunakan judul issue yang jelas dan deskriptif untuk mengidentifikasi masalah.
  • Jelaskan langkah-langkah yang akurat untuk mereproduksi masalah.
  • Jelaskan perilaku yang Anda amati setelah mengikuti langkah-langkah tersebut.
  • Jelaskan perilaku mana yang Anda harapkan untuk dilihat dan mengapa.
  • Sertakan screenshot jika memungkinkan.

Mengirimkan Pull Request

Secara umum, kami mengikuti alur kerja "fork-and-pull" Git:

  • Fork repositori ke akun Github Anda sendiri.
  • Clone proyek ke mesin Anda.
  • Buat branch secara lokal dengan nama yang ringkas namun deskriptif.
  • Commit perubahan ke branch.
  • Ikuti pedoman pemformatan dan testing apa pun yang khusus untuk repo ini.
  • Push perubahan ke fork Anda.
  • Buka sebuah PR di repositori kami.

Konvensi Coding

Pesan Git Commit

  • Gunakan bentuk waktu kini ("Tambahkan fitur" bukan "Fitur yang ditambahkan").
  • Gunakan suasana perintah ("Pindahkan kursor ke..." bukan "Memindahkan kursor ke...").
  • Batasi baris pertama hingga 72 karakter atau kurang.

JavaScript Styleguide

  • Semua kode JavaScript diverifikasi dengan Prettier dan ESLint.