Skip to content

Commit

Permalink
fix: file-file md yang belum sesuai standar linter (#203)
Browse files Browse the repository at this point in the history
* fix: file-file md yang belum sesuai standar linter

* fix: eror md linter

* fix: eror konfigurasi mergify
  • Loading branch information
sensasi-delight authored Mar 5, 2024
1 parent e96d697 commit b26cca1
Show file tree
Hide file tree
Showing 39 changed files with 455 additions and 372 deletions.
1 change: 0 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,5 @@ usahakan kamu memilih sesuai apa yang telah kamu ubah
@bellshade/docs-team
-->


<!-- jika ada gagal pada salah satu test kami akan mengeceknya kembali -->
<!-- if there is a failure in one of the tests we will check it again -->
27 changes: 17 additions & 10 deletions .mergify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,16 +53,23 @@ pull_request_rules:
- markdown files
- request docs team untuk review

# me mention maintainer yang ketika file markdown
# tedapat pada pull request
- name: review docs team untuk file markdown
conditions:
- label=markdown files
actions:
request_reviews:
users:
- ikr4mm
- azqilana
# catatan oleh @sensasi-delight 2023-05-08
# menonaktifkan konfigurasi mergify untuk notifikasi tim dokumentasi
# karena konfigurasi tersebut memunculkan eror:
# GitHub error: [422] Reviews may only be requested from collaborators.
# One or more of the users or teams you specified is not a collaborator of the bellshade/PHP repository.
# dan belum ada tim `@bellshade/docs-team`

# me mention maintainer yang ketika file markdown
# tedapat pada pull request
# - name: review docs team untuk file markdown
# conditions:
# - label=markdown files
# actions:
# request_reviews:
# users:
# - ikr4mm
# - azqilana

# me mention maintainer yang ketika file php
# terdapat pada pull request
Expand Down
29 changes: 18 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Contributing

## Daftar Isi

- [Contributor](#contributor)
- [Kategori yang tersedia](#kategori-yang-tersedia)
- [Basic](#pembelajaran-dasar-basic-learning)
Expand Down Expand Up @@ -29,12 +30,12 @@ Kami sangat senang Kamu dapat ikut berkontribusi dalam implementasi algoritma, s

Basic learning adalah kumpulan demonstrasi kode materi pemrograman PHP beserta artikel penjelasan yang lengkap, mudah di mengerti dan menarik secara visual. Dirangkai dengan alur yang runtut mulai dasar sehingga bisa dijadikan referensi untuk kalian yang belajar pemrograman PHP.

Untuk berkontribusi di repositori bellshade PHP bagian Basic ini kamu harus mengikuti urutan materi yang telah ditentukan. Daftar materi yang tersedia bisa kamu jelajahi di [Issues tag materi](https://github.com/bellshade/PHP/issues?q=is%3Aopen+is%3Aissue+label%3Abasic). Didalam issue itu kami juga menuliskan rekomendasi tentang konten yang ada dalam materi tersebut, namun kamu masih dapat menambah materi konten jika dirasa perlu.
Untuk berkontribusi di repositori bellshade PHP bagian Basic ini kamu harus mengikuti urutan materi yang telah ditentukan. Daftar materi yang tersedia bisa kamu jelajahi di [Issues tag materi](https://github.com/bellshade/PHP/issues?q=is%3Aopen+is%3Aissue+label%3Abasic). Didalam issue itu kami juga menuliskan rekomendasi tentang konten yang ada dalam materi tersebut, namun kamu masih dapat menambah materi konten jika dirasa perlu.

Semua implementasi kode untuk Basic Learning bisa ditemukan di `/basics` <br/>
dengan struktur direktori sebagai berikut <br/>

```
```text
📦 /
┣📦basics
┃ ┣ 📂x_nama_materi
Expand All @@ -47,7 +48,6 @@ dengan struktur direktori sebagai berikut <br/>

> Artikel materi ditulis pada `README.md` <br/>

### Algoritma (_Algorithm_)

Algoritma adalah langkah-langkah untuk menyelesaikan suatu pekerjaan dimana terdiri dari 3 bagian utama, yaitu:
Expand All @@ -60,7 +60,7 @@ Algoritma harus dikemas sedemikian rupa sehingga memudahkan pembaca untuk memasu

Semua implementasi kode untuk Algorithm bisa ditemukan di `/algorithms` dengan bentuk struktur seperti berikut

```
```text
📦/
┣📦algorithms
┃ ┣ 📂NamaKategoriAlgoritma
Expand All @@ -69,17 +69,19 @@ Semua implementasi kode untuk Algorithm bisa ditemukan di `/algorithms` dengan b
┃ ┃ ┃ ┗ 📜README.md
┃ ┃ ┗ 📜README.md
```

> Artikel penjelasan algoritma ditulis pada `README.md` <br/>
### Komponen / Fungsi kegunaan _(Utilities)_

Kategori utilities adalah kumpulan referensi dan contoh penggunaan komponen-komponen / fitur-fitur umum yang mungkin diperlukan oleh para web developer untuk diterapkan pada project aplikasi webnya. Didalam kategori ini, kalian dapat menjelajahi berbagai macam kebutuhan umum untuk pengembangan web umum dan mempelajari bagaimana cara mengimplementasikannya.

Utility ini adalah sesuatu yang bukan esensial dalam pengembangan web namun terkadang dibutuhkan. Bisa juga dibilang Utility ini adalah peralatan / komponen yang bisa melengkapi sebuah fitur dalam aplikasi berbasis web. Contohnya adalah seperti: Manipulasi Gambar, DateTime, Mencetak ke printer dot matrix dan sebagainya.
Utility ini adalah sesuatu yang bukan esensial dalam pengembangan web namun terkadang dibutuhkan. Bisa juga dibilang Utility ini adalah peralatan / komponen yang bisa melengkapi sebuah fitur dalam aplikasi berbasis web. Contohnya adalah seperti: Manipulasi Gambar, DateTime, Mencetak ke printer dot matrix dan sebagainya.

Semua tentang Utility dapat ditemukan pada direktori `/utilities`<br/>
dengan bentuk struktur yang mirip dengan `algorithm`

```
```text
📦/
┣📦utilities
┃ ┣ 📂NamaKategoriUtility
Expand All @@ -90,6 +92,7 @@ dengan bentuk struktur yang mirip dengan `algorithm`
┃ ┃ ┃ ┗ 📜README.md
┃ ┃ ┗ 📜README.md
```

> Artikel penjelasan utility ditulis pada `README.md` <br/>
## Standar Penulisan
Expand Down Expand Up @@ -121,7 +124,7 @@ composer phpcbf

Jika menggunakan `phpcbf` masih belum memperbaiki seluruh kesalahan yang ada, Kamu harus memperbaikinya secara manual. <br/>Kami sangat sarankan untuk Kamu jika menggunakan software text editor Visual Studio Code, Kamu dapat menggunakan ekstensi bernama [PHPCS](https://marketplace.visualstudio.com/items?itemName=ikappas.phpcs). Dengan ekstensi itu, Visual Studio Code akan menunjukkan letak kesalahannya jika Kamu melakukan kesalahan penulisan.

Pastikan Kamu sudah melakukan pengecekan ini sebelum mengajukan _*Pull Request*_ karena ini termasuk salah satu workflow yang dijalankan secara otomatis oleh kami saat Kamu mengajukan _*Pull Request*_
Pastikan Kamu sudah melakukan pengecekan ini sebelum mengajukan _Pull Request_ karena ini termasuk salah satu workflow yang dijalankan secara otomatis oleh kami saat Kamu mengajukan _Pull Request_

### Pedoman Penulisan Lainnya untuk Pembelajaran Dasar (_Basic Learning_)

Expand Down Expand Up @@ -155,14 +158,18 @@ Penggunaan layanan database seringkali dibutuhkan untuk kebanyakan kegunaan. Unt

- Hanya ada satu database untuk melayani keseluruhan project repositori ini.
- Seluruh informasi koneksi database diatur dalam satu file konfigurasi `.env`

> **_Pengecualian:_** Untuk materi basic pengenalan database, tidak perlu memuat konfigurasi .env agar mudah dipahami. Nama database menggunakan "bellshade_php"
- Default nama databasenya adalah `bellshade_php` _(yang dapat diganti di `.env`)_
- Nama tabel mengikuti format `[nomor]_[nama materi]_[nama tabel]`, spasi bisa menggunakan `_` _(underscore)_.
> **Contoh nama tabel:** `11_database_prosedural_buku`
- Nama tabel mengikuti format `[nomor]_[nama materi]_[nama tabel]`, spasi bisa menggunakan `_` _(underscore)_.

> **Contoh nama tabel:** `11_database_prosedural_buku`
Untuk membuat koneksi database, kamu perlu membuat file koneksi sendiri terlebih dahulu di folder yang sedang kamu kerjakan. Kami sudah menyediakan `config.php` pada direktori root `/` untuk memuat seluruh konfigurasi yang tertulis di `.env` _(termasuk informasi database)_. Oleh karena itu, file koneksi kamu harus `require()` ke file `config.php` ini di root `/`.

Untuk lebih mudahnya, kami menyediakan contoh file koneksi database yang dapat kamu gunakan sebagai file koneksi `connect.php`.

```php
<?php

Expand Down Expand Up @@ -235,7 +242,7 @@ Untuk menjalankan seluruh tests, gunakan command:
composer phpunit
```

Untuk memaksimalkan kelancaran workflow, pastikan Kamu melakukan testing setiap kali Kamu membuat algoritma sebelum mengajukan _*Pull Request*_.
Untuk memaksimalkan kelancaran workflow, pastikan Kamu melakukan testing setiap kali Kamu membuat algoritma sebelum mengajukan _Pull Request_.

## Pull Request

Expand All @@ -250,7 +257,7 @@ git add .
git commit -m "add: menambahkan algoritma baru"
```

- Lakukan push ke branch Kamu dan kemudian *open *pull request\*\*
- Lakukan push ke branch Kamu dan kemudian _open pull request_\*\*

**Saran Pesan Commit:**

Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,12 @@ composer install

Contoh:

```
```dotenv
BASE_URL = 'http://localhost/PHP'
```

- Kemudian kamu dapat mengaksesnya di browser dengan membuka `localhost/php` atau `127.0.0.1/php`.

<p align="center">
<img width="90%" src="./assets/images/getting-started.png"><br/><br/>
</p>
Expand All @@ -82,7 +83,7 @@ BASE_URL = 'http://localhost/PHP'

Jika kamu menggunakan Nginx sebagai Web Server, kamu memerlukan konfigurasi tambahan karena nginx tidak mendukung konfigurasi `.htaccess`. Dan karena project ini menggunakan _rewriting dan parsing url_, kamu harus menerapkan konfigurasi web server nginx berikut ini agar dapat rewrite path url menjadi sebuah parameter get yang merujuk ke `index.php`

```
```apacheconf
location / {
try_files $uri $uri/ /index.php?page=$uri;
index index.php;
Expand All @@ -93,7 +94,7 @@ location / {

Jika kamu menggunakan _web server_ bawaan PHP. Kami telah menyediakan `router.php` untuk menangani request URL. Untuk menjalankan server, kamu dapat menggunakan command ini:

```
```bash
php -S localhost:8080 router.php
```

Expand Down
3 changes: 1 addition & 2 deletions algorithms/BackTracking/PathFinding/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
## Pathfinding menggunakan Backtracking


Pathfinding adalah salah satu implementasi algoritma backtracking
yang tujuannya adalah menemukan jalan dari posisi awal sampai ke tujuan.

Expand All @@ -10,6 +9,7 @@ kotak atau cell yang tidak dapat dilalui oleh pathfinding. Oleh karena itu,
untuk mencapai tujuan, pathfinding harus mencari jalan dengan menggunakan algoritma backtracking

Skenario:

- parameter variabel x dan y digunakan untuk menentukan tempat berpijak sekarang
- indeks baris dan kolom terakhir ditetapkan sebagai tujuan. [n(xArray)-1, n(yArray)-1]

Expand All @@ -19,7 +19,6 @@ Algoritma ini dalam kalimat bahasa indonesia adalah sebagai berikut:
> Jika ya: Tandai posisi ini sebagai langkah yang benar. hentikan langkah selanjutnya
> Jika tidak: lakukan langkah berikutnya

2. cek posisi [x, y] sekarang apakah boleh dipijaki atau tidak?
> jika ya:
- Catat posisi sekarang [x, y] sebagai langkah yang benar
Expand Down
1 change: 0 additions & 1 deletion algorithms/BackTracking/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
# Algoritma Backtracking

12 changes: 6 additions & 6 deletions algorithms/Searching/Linear/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,11 +156,11 @@ Algoritma ini memiliki kelebihan dan kekurangan, sebagai gambaran

**Kelebihan** :

- Data Array yang diterima diawal tidak harus terurut, sehingga langsung bisa dapat melakukan pencarian.
- Data Array yang diterima diawal tidak harus terurut, sehingga langsung bisa dapat melakukan pencarian.

**Kelemahan** :

- Jika Array yang diterima memiliki elemen yang banyak maka akan memberatkan kinerja dari perangkat kita.
- Jika Array yang diterima memiliki elemen yang banyak maka akan memberatkan kinerja dari perangkat kita.

dalam hal demikian algoritma ini baik digunakan untuk pencarian dalam data kecil dengan data array berupa linear ( array satu dimensi ), walaupun dapat digunakan untuk pencarian di dalam array multi dimensi dengan metode recursive, tetapi hal tersebut <b>dapat membebani memory perangkat</b>.

Expand All @@ -185,10 +185,10 @@ class .......
?>
```

[![](https://img.shields.io/static/v1?&label=Contoh%20Kode&message=%3e&color)](LinearSearch.php)
[![Tautan file untuk contoh kode Linear Search](https://img.shields.io/static/v1?&label=Contoh%20Kode&message=%3e&color)](LinearSearch.php)

### Referensi

- Programiz. _"Linear Search C, C++, Java, Python"_. [Pranala Luar](https://www.programiz.com/dsa/linear-search).
- Edy Budiman. _"Belajar Dasar: Algoritma dan Pemograman"_. Repository Unmul.
- Udy Manber. _Using Mathematical Induction to Design Computer Algorithms_, Computer Science Technical Report#660. 1986
- Programiz. _"Linear Search C, C++, Java, Python"_. [Pranala Luar](https://www.programiz.com/dsa/linear-search).
- Edy Budiman. _"Belajar Dasar: Algoritma dan Pemograman"_. Repository Unmul.
- Udy Manber. _Using Mathematical Induction to Design Computer Algorithms_, Computer Science Technical Report#660. 1986
2 changes: 1 addition & 1 deletion algorithms/Searching/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<p align="center">
<img width="15%" src="./../assets/images/phplogo.png" />
<h1 align="center">Searching Algorithms</h1>
</p>
</p>
4 changes: 2 additions & 2 deletions algorithms/Searching/Ternary/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -456,8 +456,8 @@ public function testNumericArray()

Setelah unit test kita susun, test dapat kita lakukan melalui terminal dengan perintah seperti di bawah ini.

```text
$ phpunit
```bash
phpunit
```

jika test berhasil akan menghasilkan info seperti di bawah ini.
Expand Down
Loading

0 comments on commit b26cca1

Please sign in to comment.