@sideid/id-profanity-filter 1.11.13 → 1.13.0

package/CONTRIBUTING.md

@@ -1,151 +1,113 @@
-# Panduan Kontribusi untuk ID-Profanity-Filter
-
-Terima kasih telah mempertimbangkan untuk berkontribusi pada proyek ID-Profanity-Filter! Panduan ini akan menjelaskan proses kontribusi, terutama untuk menambahkan kata kotor baru ke dalam database.
-
-## Cara Berkontribusi
-
-### 1. Fork & Clone Repositori
-
-- Fork repositori ini ke akun GitHub Anda
-- Clone repositori fork Anda ke komputer lokal:
-  ```bash
-  git clone https://github.com/username/id-profanity-filter.git
-  cd id-profanity-filter
-  ```
-
-### 2. Install Dependensi
-
-```bash
-npm install
-```
-
-### 3. Buat Branch Baru
-
-```bash
-git switch -c add-kata-kotor-daerah
-```
-
-## Struktur Kata Kotor
-
-Kata-kata kotor dalam proyek ini dikelompokkan berdasarkan dua dimensi:
-
-### Berdasarkan Daerah Asal
-
-Lokasi file: `src/constants/regions/`
-
-Kata-kata dikelompokkan berdasarkan daerah asalnya di Indonesia, seperti:
-- `general.ts` - Kata-kata umum di Indonesia
-- `jawa.ts` - Kata-kata dari Jawa
-- `sunda.ts` - Kata-kata dari Sunda
-- `betawi.ts` - Kata-kata dari Betawi
-- `batak.ts` - Kata-kata dari Batak
-- ... dan daerah lainnya
-
-### Berdasarkan Kategori
-
-Lokasi file: `src/constants/categories/`
-
-Kata-kata juga dikelompokkan berdasarkan jenisnya:
-- `sexual.ts` - Kata-kata berbau seksual
-- `insult.ts` - Kata-kata penghinaan
-- `profanity.ts` - Umpatan umum
-- `slur.ts` - Kata-kata merendahkan berdasarkan identitas
-- `drugs.ts` - Kata-kata terkait narkoba
-- `disgusting.ts` - Kata-kata menjijikkan
-- `blasphemy.ts` - Kata-kata penistaan agama
-
-## Cara Menambahkan Kata Kotor Baru
-
-### 1. Menambahkan ke File Daerah
-
-Pilih file daerah yang sesuai di `src/constants/regions/` atau buat file baru jika daerah tersebut belum ada. Format entri kata kotor harus mengikuti interface `ProfanityWord`:
+# Panduan kontribusi
+
+Panduan ini menjelaskan alur kerja untuk mengembangkan kode dan menambahkan kata baru ke dalam database kata kotor `id-profanity-filter`.
+
+## Memulai pengembangan
+
+1. Fork repositori ini ke akun GitHub Anda, lalu clone secara lokal:
+   ```bash
+   git clone https://github.com/username/id-profanity-filter.git
+   cd id-profanity-filter
+   ```
+
+2. Pasang dependensi:
+   ```bash
+   bun install
+   # atau
+   npm install
+   ```
+
+3. Buat branch baru untuk fitur atau perbaikan Anda:
+   ```bash
+   git checkout -b feature/tambah-kata-daerah
+   ```
+
+## Struktur data kata
+
+Kata-kata kotor dalam proyek ini dikelompokkan ke dalam dua dimensi:
+
+### 1. Berdasarkan daerah asal (`src/constants/regions/`)
+File daerah saat ini mencakup:
+- `general.ts`: kata umum nasional
+- `jawa.ts`: bahasa Jawa
+- `sunda.ts`: bahasa Sunda
+- `betawi.ts`: dialek Betawi
+- `batak.ts`: bahasa Batak
+- `minang.ts`: bahasa Minang
+- `bali.ts`: bahasa Bali
+- `madura.ts`: bahasa Madura
+- `aceh.ts`: bahasa Aceh
+
+### 2. Berdasarkan kategori (`src/constants/categories/`)
+- `sexual.ts`: istilah seksual vulgar
+- `insult.ts`: hinaan dan caci maki
+- `profanity.ts`: umpatan umum
+- `slur.ts`: kata diskriminatif / pelecehan SARA
+- `drugs.ts`: istilah narkoba
+- `disgusting.ts`: hal jorok atau menjijikkan
+- `blasphemy.ts`: penistaan agama
+
+## Menambahkan kata kotor baru
+
+Setiap entri kata kotor harus mengikuti interface `ProfanityWord`:
 
 ```typescript
 {
-  word: 'kata_kotor',        // Kata kotor dalam bentuk dasarnya
-  category: 'insult',        // Kategori kata (sexual, insult, profanity, slur, drugs, disgusting, blasphemy)
-  region: 'nama_daerah',     // Daerah asal kata
-  severity: 0.7,             // Tingkat keparahan (0-1)
-  aliases: ['alias1', 'alias2'], // Variasi atau alias kata (opsional)
-  description: 'Deskripsi kata', // Penjelasan singkat tentang kata (opsional)
-  context: 'Konteks penggunaan' // Informasi konteks penggunaan (opsional)
+  word: 'kata_dasar',          // Kata kotor dalam bentuk dasar
+  category: 'insult',          // Kategori kata
+  region: 'jawa',              // Daerah asal kata
+  severity: 0.7,               // Tingkat keparahan dari 0.0 sampai 1.0
+  aliases: ['alias1', 'alias2'], // Variasi penulisan atau singkatan lazim (opsional)
+  description: 'Penjelasan',   // Arti kata (opsional)
+  context: 'Konteks kata'      // Situasi penggunaan kata (opsional)
 }
 ```
 
-Contoh menambahkan kata ke file daerah (misalnya `bali.ts`):
-
-```typescript
-import { ProfanityWord } from '../../types';
-
-export const bali: ProfanityWord[] = [
-  // ... kata-kata yang sudah ada
-  {
-    word: 'cicing',
-    category: 'profanity',
-    region: 'bali',
-    severity: 0.6,
-    aliases: ['cicying'],
-    description: 'Secara harfiah berarti anjing dalam Bahasa Bali',
-    context: 'Umpatan umum dalam Bahasa Bali'
-  },
-  // ... tambahkan kata lainnya
-];
-
-export const baliWords = bali.map(item => item.word);
-
-export default bali;
-```
-
-### 2. Menambahkan ke File Kategori (Opsional)
+### Langkah penambahan kata
 
-Jika Anda menambahkan kata baru, perbarui juga file kategori yang sesuai (`src/constants/categories/`). Kata-kata tersebut akan otomatis terambil saat library dibuild, tetapi terkadang kategori perlu diperbarui.
+1. Tambahkan objek kata ke file daerah terkait di `src/constants/regions/<daerah>.ts`.
+2. Jika kata termasuk ke kategori tertentu, pastikan kata juga tercatat di `src/constants/categories/<kategori>.ts`.
+3. Pastikan kata didaftarkan pada `wordObjects` di `src/constants/wordList.ts` jika menambahkan file daerah baru.
 
-### 3. Update File indeks Daerah/Kategori (jika ada daerah baru)
+## Pengujian dan build
 
-Jika Anda menambahkan daerah baru, pastikan untuk memperbarui file indeks:
-- `src/constants/regions/index.ts`
-- `src/constants/wordList.ts`
-
-### 4. Jalankan Tes (jika ada)
+Sebelum membuat pull request, jalankan pengujian dan linter untuk memastikan tidak ada regresi:
 
 ```bash
+# Jalankan test suite
+bun test
+# atau
 npm test
-```
 
-### 5. Build Library
+# Jalankan linter
+bun run lint
+# atau
+npm run lint
 
-```bash
+# Pastikan build bundle berhasil
+bun run build
+# atau
 npm run build
 ```
 
-### 6. Commit dan Push Perubahan Anda
-
-```bash
-git add .
-git commit -m "Menambahkan kata kotor daerah X"
-git push origin add-kata-kotor-daerah
-```
-
-### 7. Buat Pull Request
+## Pedoman kurasi kata
 
-Buat Pull Request dari branch Anda ke repositori utama.
+- **Bentuk dasar**: Masukkan kata dalam bentuk dasar (tanpa imbuhan). Variasi ejaan dapat dimasukkan ke dalam `aliases`.
+- **Hindari alias terlalu pendek yang ambigu**: Jangan menambahkan alias 1 atau 2 huruf jika kata tersebut merupakan kata umum atau singkatan lazim dalam bahasa Indonesia (misalnya `we`, `sl`, `cd`) untuk mencegah false positive.
+- **Skor keparahan realistis**:
+  - `0.1 - 0.4`: Celaan ringan atau umpatan santai sehari-hari
+  - `0.5 - 0.7`: Hinaan kasar atau umpatan bernada marah
+  - `0.8 - 1.0`: Kata seksual vulgar eksplisit, penistaan, atau slur diskriminatif berat
+- **Cek duplikasi**: Pastikan kata belum ada di file daerah lain sebelum menambahkan.
 
-## Pedoman Penambahan Kata
+## Mengajukan perubahan
 
-1. **Validasi Kata**: Pastikan kata tersebut benar-benar dianggap kasar di daerah yang dimaksud.
-2. **Metadata**: Tambahkan metadata yang cukup, terutama tingkat keparahan dan kategori.
-3. **Konteks**: Tambahkan komentar konteks jika diperlukan untuk menjelaskan kata tersebut.
-4. **Bentuk Dasar**: Tambahkan kata dalam bentuk dasarnya, variasi dapat ditambahkan dalam `aliases`.
-5. **Kategorisasi**: Kategorikan kata dengan benar (seksual, hinaan, umpatan, dll).
-6. **Hindari Duplikasi**: Periksa apakah kata tersebut sudah ada sebelum menambahkannya.
+Commit perubahan Anda dengan pesan yang jelas dan deskriptif:
 
-## Format Commit
-
-Gunakan format commit yang konsisten:
-- `Add: Menambahkan kata X dari daerah Y`
-- `Update: Memperbaiki metadata kata X`
-- `Fix: Memperbaiki bug pada ...`
-
-## Informasi Tambahan
+```bash
+git add -A
+git commit -m "feat(words): tambah kata kasar dari bahasa Jawa"
+git push origin feature/tambah-kata-daerah
+```
 
-Untuk pertanyaan atau diskusi, silakan buat issue di GitHub atau hubungi maintainer proyek. Terima kasih atas kontribusi Anda!
+Lalu buat pull request ke branch `main` repositori utama dengan deskripsi kata apa saja yang ditambahkan beserta artinya.