Peta proyek
Proyek ini terdiri dari lima repository. Mereka nyambung kayak rantai: dua provider yang ngobrol sama API Biznet GIO, dua repo contoh yang nunjukin tiap fitur provider itu jalan, dan satu situs docs yang ngajarin dua-duanya.
Section Contribute ini ngurusin tiga repo yang bisa lu ubah tanpa pengetahuan provider yang dalam: situs docs dan dua repo contoh. Dua repo provider itu codebase Go dengan alur development mereka sendiri; kalau lu nemu bug provider, laporin sebagai issue di repo provider dan biasanya dibenerin di situ duluan.
Gimana repo-repo saling komunikasi
Tiga repo itu terus-terusan ngerujuk satu sama lain, dan wiring itu bagian dari desainnya:- Repo contoh nge-link ke tutorial situs docs yang ngejelasin pattern yang mereka pake, kayak tutorial Capstone.
- Situs docs nge-link ke repo contoh di halaman examples, di menu sidebar GitHub, dan dari halaman reference.
- Halaman reference situs docs nunjukin code yang harus cocok sama yang provider dan contoh lakuin beneran. Pas contoh nemu mismatch, contoh dan docs dua-duanya dibenerin bareng.
Urutan baca
Ikutin urutan ini kalau lu baru di sini:- Gimana repo-repo diorganisir biar tau semua ada di mana.
- Setup lokal buat dapetin tools dan token yang lu butuhin.
- Konvensi buat belajar aturan rumah sebelum lu nulis apa pun.
- Commits dan pull requests buat belajar alur kontribusinya.
- Issues dan CODEOWNERS dan reviews buat belajar gimana komunikasi dan review jalan.
- Pipelines buat ngerti safety net yang tiap perubahan lewatin.
- Deep dive repo, Terraform dan Pulumi, buat ngerti code-nya sendiri, plus complete code walkthrough buat referensi file per file yang lengkap.
- Walkthroughs step-by-step pas lu siap bikin perubahan pertama.
Standar yang proyek ini ikutin
Tiap konvensi yang proyek ini pake itu standar yang dipublikasiin. Halaman-halaman di atas nge-link ke sumber kanonik buat masing-masing, tapi ini tiga yang paling gede duluan:Conventional Commits
Tiap pesan commit ngikutin spec ini, yang sama kayak yang dipake kebanyakan proyek open source gede.
GitHub Flow
Fork, branch dari main, buka pull request, review, merge. Gak ada yang lebih ribet dari itu.
GitHub issue forms dan CODEOWNERS
Issue templates, pull request templates, dan aturan kepemilikan semuanya dikonfigurasi per repo di .github.
CONTRIBUTING.md di root-nya yang ngerangkum aturannya sendiri dan nge-link balik ke sini: