docs: tambah CONTRIBUTING.md, update .env.example, tambah link di README

This commit is contained in:
2026-04-03 12:19:39 +07:00
parent 64c5614191
commit 3fd286ac22
3 changed files with 99 additions and 32 deletions
+11 -32
View File
@@ -1,31 +1,27 @@
APP_NAME=Laravel APP_NAME=Persegi
APP_ENV=local APP_ENV=local
APP_KEY= APP_KEY=
APP_DEBUG=true APP_DEBUG=true
APP_URL=http://localhost APP_URL=http://localhost
APP_LOCALE=en APP_LOCALE=id
APP_FALLBACK_LOCALE=en APP_FALLBACK_LOCALE=id
APP_FAKER_LOCALE=en_US APP_FAKER_LOCALE=id_ID
APP_MAINTENANCE_DRIVER=file APP_MAINTENANCE_DRIVER=file
# APP_MAINTENANCE_STORE=database
# PHP_CLI_SERVER_WORKERS=4
BCRYPT_ROUNDS=12 BCRYPT_ROUNDS=12
LOG_CHANNEL=stack LOG_CHANNEL=stack
LOG_STACK=single LOG_STACK=single
LOG_DEPRECATIONS_CHANNEL=null
LOG_LEVEL=debug LOG_LEVEL=debug
DB_CONNECTION=sqlite DB_CONNECTION=mysql
# DB_HOST=127.0.0.1 DB_HOST=127.0.0.1
# DB_PORT=3306 DB_PORT=3306
# DB_DATABASE=laravel DB_DATABASE=persegi
# DB_USERNAME=root DB_USERNAME=root
# DB_PASSWORD= DB_PASSWORD=
SESSION_DRIVER=database SESSION_DRIVER=database
SESSION_LIFETIME=120 SESSION_LIFETIME=120
@@ -38,28 +34,11 @@ FILESYSTEM_DISK=local
QUEUE_CONNECTION=database QUEUE_CONNECTION=database
CACHE_STORE=database CACHE_STORE=database
# CACHE_PREFIX=
MEMCACHED_HOST=127.0.0.1
REDIS_CLIENT=phpredis
REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379
MAIL_MAILER=log MAIL_MAILER=log
MAIL_SCHEME=null
MAIL_HOST=127.0.0.1 MAIL_HOST=127.0.0.1
MAIL_PORT=2525 MAIL_PORT=2525
MAIL_USERNAME=null MAIL_USERNAME=null
MAIL_PASSWORD=null MAIL_PASSWORD=null
MAIL_FROM_ADDRESS="hello@example.com" MAIL_FROM_ADDRESS="noreply@persegi.id"
MAIL_FROM_NAME="${APP_NAME}" MAIL_FROM_NAME="${APP_NAME}"
AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=
AWS_USE_PATH_STYLE_ENDPOINT=false
VITE_APP_NAME="${APP_NAME}"
+82
View File
@@ -0,0 +1,82 @@
# Panduan Kontribusi
Terima kasih telah tertarik berkontribusi pada proyek **Persegi**!
---
## Prasyarat
- PHP >= 8.4
- Composer
- MySQL / MariaDB
- Node.js (opsional, untuk asset)
---
## Setup Lokal
```bash
git clone <repo-url>
cd persegi
composer install
cp .env.example .env
php artisan key:generate
```
Isi konfigurasi database di `.env`:
```
DB_DATABASE=persegi
DB_USERNAME=root
DB_PASSWORD=
```
Lalu jalankan:
```bash
php artisan migrate --seed
php artisan shield:generate --panel=admin
php artisan shield:super-admin --user=1
php artisan serve
```
Akses admin panel: `http://localhost:8000/dashboard`
Untuk notifikasi & queue:
```bash
php artisan queue:work
```
---
## Alur Kontribusi
1. Fork repository ini
2. Buat branch baru: `git checkout -b feat/nama-fitur`
3. Lakukan perubahan
4. Commit dengan pesan yang jelas (gunakan bahasa Indonesia):
```
feat: tambah fitur X
fix: perbaiki bug Y
docs: update dokumentasi Z
```
5. Push ke fork kamu: `git push origin feat/nama-fitur`
6. Buat Pull Request ke branch `master`
---
## Konvensi Kode
- Ikuti struktur yang sudah ada: Resource → `app/Filament/Resources/{Nama}/`
- Pisahkan Form, Table, dan Pages ke file terpisah
- Gunakan Observer untuk side-effect (log, notifikasi)
- Semua aksi penting wajib dicatat ke `activity_logs`
- Jangan hardcode permission — gunakan Filament Shield
---
## Melaporkan Bug
Buka issue dengan menyertakan:
- Langkah untuk mereproduksi
- Pesan error lengkap
- Role user yang mengalami bug
+6
View File
@@ -161,3 +161,9 @@ php artisan route:cache
php artisan view:cache php artisan view:cache
php artisan permission:cache-reset php artisan permission:cache-reset
``` ```
---
## Kontribusi
Lihat [CONTRIBUTING.md](CONTRIBUTING.md) untuk panduan berkontribusi.