Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (31 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

48 lines (31 loc) · 3.09 KB

Contributing

Terima Kasih sudah mau menjadi contributor berikut ada beberapa hal yang bisa dilakukan untuk berkontribusi dan tahapanya.

Macam-macam kontribusi

Enchantment/Penambahan Fitur

Fitur-fitur yang di perlukan oleh website akan dibuat dalam issue. Contributor bisa mengerjakanya.

  1. Disarankan untuk mengclaim issue Disarankan chat terlebih dahulu di github issue untuk mengclaim issue ("Aku mengerjakan issue ini ya") lalu tunggu acc dari admin. Sebenarnya boleh saja tidak mengclaim issue tersebut, Namun ada resiko orang lain mengerjakan issue yang sama.
  2. Fork Project, Mengerjakan issue dan pull request Seperti project opensource lainya Tahapan kontribusi fork project, mengerjakan issue dan pull request. dengan sistem seperti ini siapapun bisa berkontribusi.
  3. Code Review dan Merge Pull Request Setelah pull request admin akan melakukan review. Di review tersebut bisa langsung merge atau akan ada permintaan code changes. Jika ada permintaan code changes harap dikerjakan atau jika tidak setuju dengan pendapat admin bisa menjelaskanya.

Bug

Ada 3 cara kontribusi untuk fixbug

  1. Fix bug issue Tahapanya sama seperti di Enchantment/Penambahan Fitur.
  2. Membuat bug issue di github Kontributor membuat bug issue dan menjelaskan secara detail bug tersebut dan bagaimana bug tersebut bisa muncul.
  3. Membuat bug issue dan fix bug issue Gabungan antara no 1 dan 2

Documentation

Jika kalian menemukan typo atau ingin menambah/mengubah informasi untuk mempermudah kontributor. Ini juga diperbolehkan. Tahapanya Fork -> menambah dokumentasi -> pull request. Nanti akan direview oleh admin jika disetujui akan di merge.

Idea

Jika kalian memiliki ide fitur menarik yang bisa ditambahkan. Silahkan membuat issue di github. Jika disetujui nanti akan dikonversi menjadi Enchantment/Penambahan Fitur yang bisa dikerjakan bersama-sama oleh kontributor.

FAQ

Diharapkan kontributor bisa mematuhi standard berikut

Q: Kalau ada kesulitan dalam mengerjakan project bagaimana?

A:Jika ada kesulitan atau ketidakjelasan di issue diharapkan kontributor untuk bertanya. Bisa comment di github issue, membuat issue baru atau bertanya di telegram bandungpy/PythonID (topik opensource). Jangan malu untuk bertanya.

Q: Untuk code adakah standard yang digunakan?

A: Mengingat ini project opensource maka perlu diterapkan best practice seperti code formating dan testing. Untuk code formating dan linting project ini menggunakan biome https://biomejs.dev/ pastikan code yang di pull request sudah diformat dan linting menggunakan biome (npm run check). Pastikan code yang di pull request bisa di build tanpa error dan warning (npm run build). Selain itu karena project ini juga menggunakan typescript pastikan juga code lolos typechecking (npm run typecheck).

Q: Kalau saya berkontribusi apakah saya akan dibayar?

A: Tidak. Project ini tidak akan membayar kontributor dan tidak akan meminta bayaran dari kontributor. Tujuan dari project opensource ini adalah memberikan kesempatan kepada developer-developer di indonesia untuk menunjukan kemampuanya terlepas dari background pekerjaan, umur, gender, expertise ataupun pengalaman kerja.