| 1 | # Berkontribusi pada Codewhale |
| 2 | |
| 3 | Terima kasih atas minat Anda untuk berkontribusi pada Codewhale! Dokumen ini memberikan panduan dan instruksi untuk berkontribusi. |
| 4 | |
| 5 | --- |
| 6 | |
| 7 | ## Memulai (Getting Started) |
| 8 | |
| 9 | ### Prasyarat |
| 10 | |
| 11 | - Rust 1.88 atau lebih baru (edisi 2024) |
| 12 | - Pengelola paket Cargo |
| 13 | - Git |
| 14 | |
| 15 | ### Menyiapkan Lingkungan Pengembangan |
| 16 | |
| 17 | 1. Fork dan klon repositori: |
| 18 | ```bash |
| 19 | git clone https://github.com/USERNAME_ANDA/CodeWhale.git |
| 20 | cd CodeWhale |
| 21 | ``` |
| 22 | |
| 23 | 2. Kompilasi proyek: |
| 24 | ```bash |
| 25 | cargo build |
| 26 | ``` |
| 27 | |
| 28 | 3. Jalankan pengujian (tests): |
| 29 | ```bash |
| 30 | cargo test --workspace --all-features |
| 31 | ``` |
| 32 | |
| 33 | 4. Jalankan dalam mode pengembangan: |
| 34 | ```bash |
| 35 | cargo run --bin codewhale |
| 36 | ``` |
| 37 | |
| 38 | --- |
| 39 | |
| 40 | ## Alur Kerja Pengembangan |
| 41 | |
| 42 | ### Gaya Kode (Code Style) |
| 43 | |
| 44 | - Jalankan `cargo fmt` sebelum melakukan commit untuk memastikan format kode konsisten. |
| 45 | - Jalankan `cargo clippy` dan atasi seluruh peringatan. |
| 46 | - Ikuti konvensi penamaan Rust (`snake_case` untuk fungsi/variabel, `CamelCase` untuk tipe data/struct). |
| 47 | - Tambahkan komentar dokumentasi untuk API publik. |
| 48 | |
| 49 | ### Pengujian |
| 50 | |
| 51 | - Tulis pengujian untuk fungsionalitas baru. |
| 52 | - Pastikan seluruh pengujian yang ada lulus: `cargo test --workspace --all-features`. |
| 53 | - Tempatkan unit test di samping kode yang diuji (`#[cfg(test)]`), serta tambahkan pengujian integrasi di bawah direktori `tests/` pada crate yang bersangkutan. |
| 54 | |
| 55 | --- |
| 56 | |
| 57 | ## Pengajuan Pull Request (PR) |
| 58 | |
| 59 | 1. Buat branch baru dari `main` untuk fitur atau perbaikan Anda. |
| 60 | 2. Pastikan `cargo fmt`, `cargo clippy`, dan pengujian lulus sebelum mengajukan PR. |
| 61 | 3. Tulis judul dan deskripsi PR yang jelas yang menjelaskan tujuan perubahan. |
| 62 | 4. Setiap kontributor akan mendapatkan kredit dalam changelog dan `docs/CONTRIBUTORS.md`. |
| 63 |