odon
/
free-pmo
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

Update README.md and CONTRIBUTING.md

pull/1/head
Nafies Luthfi 8 years ago
parent
68c8b0fef4
commit
890b98c6fc
2 changed files with 21 additions and 21 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 6
      CONTRIBUTING.md
  2. 36
      README.md

6
CONTRIBUTING.md
View File

@ -3,7 +3,7 @@
Terima kasih karena telah berkenan mempertimbangkan untuk berkontribusi pada project ini. Mari kita buat software Free PMO menjadi jauh lebih baik. Terima kasih karena telah berkenan mempertimbangkan untuk berkontribusi pada project ini. Mari kita buat software Free PMO menjadi jauh lebih baik.
### Submit Issue ### Submit Issue
Project ini masih terus dikembangkan. Sebagian besar fitur yang telah dibuat memiliki **Feature** atau **Unit Testing**, namun sangat mungkin masih ada **bug** yang terlewat dari pengujian tersebut. Jika selama menggunakan software ini Anda temukan **bug** atau **error**, silakan [melaporkan **Issue**](https://github.com/nafiesl/free-pmo/issues/new){:target="_blank"} dengan **prefix Subject : [BUG]**.
Project ini masih terus dikembangkan. Sebagian besar fitur yang telah dibuat memiliki **Feature** atau **Unit Testing**, namun sangat mungkin masih ada **bug** yang terlewat dari pengujian tersebut. Jika selama menggunakan software ini Anda temukan **bug** atau **error**, silakan [melaporkan **Issue**](https://github.com/nafiesl/free-pmo/issues/new) dengan **prefix Subject : [BUG]**.
Kita akan mencoba minimalisir **bug** sebisa mungkin. Kita akan mencoba minimalisir **bug** sebisa mungkin.
@ -20,7 +20,7 @@ Wah, bagian ini adalah kontribusi yang luar biasa, Anda sudah berkenan meluangka
#### 1. Bugfix #### 1. Bugfix
Di mana Anda membantu dalam **perbaikan error** yang dilaporkan oleh kontributor lain melalui [**Issue**](https://github.com/nafiesl/free-pmo/issues){:target="_blank"}. Jika perbaikan error ini berkaitan dengan interaksi ke database (CRUD Operation), mohon agar Anda :
Di mana Anda membantu dalam **perbaikan error** yang dilaporkan oleh kontributor lain melalui [**Issue**](https://github.com/nafiesl/free-pmo/issues). Jika perbaikan error ini berkaitan dengan interaksi ke database (CRUD Operation), mohon agar Anda :
1. Membuat **testing**, terkait fitur yang memiliki bug. 1. Membuat **testing**, terkait fitur yang memiliki bug.
2. Pastikan **semua testing passed** pada saat Anda melakukan **pull request**. 2. Pastikan **semua testing passed** pada saat Anda melakukan **pull request**.
@ -35,7 +35,7 @@ Pada project ini sangat mungkin terjadi kesalahan penulisan pada `halaman web` s
Jenis **pull request** ini akan menambahkan fitur baru pada Free PMO. Jika Anda ingin melakukan pull request jenis ini, kami harapkan agar memenuhi ketentuan berikut : Jenis **pull request** ini akan menambahkan fitur baru pada Free PMO. Jika Anda ingin melakukan pull request jenis ini, kami harapkan agar memenuhi ketentuan berikut :
1. Sebelumnya fitur ini sudah diusulkan dan dibahas pada [**Issue**](https://github.com/nafiesl/free-pmo/issues){:target="_blank"}.
1. Sebelumnya fitur ini sudah diusulkan dan dibahas pada [**Issue**](https://github.com/nafiesl/free-pmo/issues).
2. Fitur tambahan dilengkapi dengan Feature Test atau Unit Test sesuai keperluan (terutama jika ada interaksi perubahan pada database). 2. Fitur tambahan dilengkapi dengan Feature Test atau Unit Test sesuai keperluan (terutama jika ada interaksi perubahan pada database).
3. Semua **testing passed** 3. Semua **testing passed**

36
README.md
View File

@ -25,7 +25,7 @@ Free PMO (Project Management Office), software management project untuk *freelan
1. **Free** bisa jadi singkatan dari **Freelancer**, bisa juga **Free Software** (merdeka), dan tentunya **Free (gratis)**. 1. **Free** bisa jadi singkatan dari **Freelancer**, bisa juga **Free Software** (merdeka), dan tentunya **Free (gratis)**.
2. **PMO** singkatan dari ***Project Management Office***, ibarat kantor untuk pengelolaan project. 2. **PMO** singkatan dari ***Project Management Office***, ibarat kantor untuk pengelolaan project.
Fitur utama Free PMO adalah pengelolaan project dan transaksi pembayaran setiap project. Fitur-fitur lain software ini tertuang dalam file [konsep](CONCEPT.md){:target="_blank"}.
Fitur utama Free PMO adalah pengelolaan project dan transaksi pembayaran setiap project. Fitur-fitur lain software ini tertuang dalam file [konsep](CONCEPT.md).
## Tujuan ## Tujuan
@ -35,7 +35,7 @@ Tujuan utama Free PMO adalah membantu pengelolaan data project dengan mudah dan
Aplikasi ini dapat dipasang dalam server lokal (PC/Laptop) dan server online, dengan spesifikasi berikut : Aplikasi ini dapat dipasang dalam server lokal (PC/Laptop) dan server online, dengan spesifikasi berikut :
#### Spesifikasi minimum server #### Spesifikasi minimum server
1. PHP 7.0 (dan memenuhi [server requirement Laravel 5.5](https://laravel.com/docs/5.5#server-requirements){:target="_blank"}),
1. PHP 7.0 (dan memenuhi [server requirement Laravel 5.5](https://laravel.com/docs/5.5#server-requirements)),
2. MySQL atau MariaDB, 2. MySQL atau MariaDB,
3. SQlite (untuk automated testing). 3. SQlite (untuk automated testing).
@ -54,7 +54,7 @@ Aplikasi ini dapat dipasang dalam server lokal (PC/Laptop) dan server online, de
11. Isi formulir installasi. 11. Isi formulir installasi.
12. Selesai, Anda akan login sebagai admin. 12. Selesai, Anda akan login sebagai admin.
<center>![Install Free PMO](public/screenshots/pmo-install-free-pmo.jpg)</center>
![Install Free PMO](public/screenshots/pmo-install-free-pmo.jpg)
## Developer dan Kontributor ## Developer dan Kontributor
@ -63,19 +63,19 @@ Project ini dikembangkan oleh [Nafies Luthfi](https://github.com/nafiesl) dan pa
## Ramuan ## Ramuan
Free PMO dibangun menggunakan [metode TDD](https://blog.nafies.id/laravel/testing-laravel-tentang-automated-testing){:target="_blank"} dengan bahan dan dukungan dari paket-paket berikut ini :
Free PMO dibangun menggunakan [metode TDD](https://blog.nafies.id/laravel/testing-laravel-tentang-automated-testing) dengan bahan dan dukungan dari paket-paket berikut ini :
##### Dependencies ##### Dependencies
* [Framework Laravel](https://laravel.com/docs/5.5){:target="_blank"} (versi 5.2 s/d 5.5).
* [luthfi/formfield](https://github.com/nafiesl/FormField){:target="_blank"}, Wrapper Form dari [laravelcollective/html](https://github.com/laravelcollective/html){:target="_blank"} dengan Bootstrap 3.
* [riskihajar/terbilang](https://github.com/riskihajar/terbilang){:target="_blank"}, membuat angka terbilang (pada fitur cetak kuitansi) dan romawi.
* [Framework Laravel](https://laravel.com/docs/5.5) (versi 5.2 s/d 5.5).
* [luthfi/formfield](https://github.com/nafiesl/FormField), Wrapper Form dari [laravelcollective/html](https://github.com/laravelcollective/html) dengan Bootstrap 3.
* [riskihajar/terbilang](https://github.com/riskihajar/terbilang), membuat angka terbilang (pada fitur cetak kuitansi) dan romawi.
##### Dev Dependencies ##### Dev Dependencies
* [PHPUnit](https://github.com/sebastianbergmann/phpunit){:target="_blank"}, PHP testing framework.
* [laravel/browser-kit-testing](https://github.com/laravel/browser-kit-testing){:target="_blank"}, paket browserkit testing untuk Laravel ^5.4.
* [luthfi/simple-crud-generator](https://github.com/nafiesl/SimpleCrudGenerator){:target="_blank"}, CRUD generator berupa artisan command untuk mempercepat workflow TDD.
* [johnkary/phpunit-speedtrap](https://github.com/johnkary/phpunit-speedtrap){:target="_blank"}, pengecekan testing yang lambat (karena query atau proses yang kurang efektif).
* [PHPUnit](https://github.com/sebastianbergmann/phpunit), PHP testing framework.
* [laravel/browser-kit-testing](https://github.com/laravel/browser-kit-testing), paket browserkit testing untuk Laravel ^5.4.
* [luthfi/simple-crud-generator](https://github.com/nafiesl/SimpleCrudGenerator), CRUD generator berupa artisan command untuk mempercepat workflow TDD.
* [johnkary/phpunit-speedtrap](https://github.com/johnkary/phpunit-speedtrap), pengecekan testing yang lambat (karena query atau proses yang kurang efektif).
## Lisensi ## Lisensi
@ -83,24 +83,24 @@ Project Free PMO merupakan software free dan open source di bawah [lisensi MIT](
## Cara Berkontribusi ## Cara Berkontribusi
Jika ingin berkontribusi terhadap project ini, baik untuk membuat *Issue*, usulan Fitur tambahan, *Pull Request*, maupun donasi, silakan melihat [panduan kontribusi](CONTRIBUTING.md){:target="_blank"}.
Jika ingin berkontribusi terhadap project ini, baik untuk membuat *Issue*, usulan Fitur tambahan, *Pull Request*, maupun donasi, silakan melihat [panduan kontribusi](CONTRIBUTING.md).
## Screenshots ## Screenshots
#### Dashboard #### Dashboard
![Free PMO Dashboard](public/screenshots/pmo-dashboard-01.jpg){:title="Free PMO Dashboard"}
![Free PMO Dashboard](public/screenshots/pmo-dashboard-01.jpg)
#### Detail Project #### Detail Project
![Free PMO Project Detail](public/screenshots/pmo-project-detail-01.jpg){:title="Free PMO Project Detail"}
![Free PMO Project Detail](public/screenshots/pmo-project-detail-01.jpg)
#### List Job Project #### List Job Project
![Free PMO Project Job List](public/screenshots/pmo-project-jobs-01.jpg){:title="Free PMO Project Job List"}
![Free PMO Project Job List](public/screenshots/pmo-project-jobs-01.jpg)
#### Detail Job Project #### Detail Job Project
![Free PMO Job Tasks](public/screenshots/pmo-job-tasks-01.jpg){:title="Free PMO Job Tasks"}
![Free PMO Job Tasks](public/screenshots/pmo-job-tasks-01.jpg)
#### Laporan Tahunan #### Laporan Tahunan
![Free PMO Yearly Report](public/screenshots/pmo-yearly-report-01.jpg){:title="Free PMO Yearly Report"}
![Free PMO Yearly Report](public/screenshots/pmo-yearly-report-01.jpg)
#### Automated Testing #### Automated Testing
@ -108,4 +108,4 @@ Jika ingin berkontribusi terhadap project ini, baik untuk membuat *Issue*, usula
$ vendor/bin/phpunit $ vendor/bin/phpunit
``` ```
<center>![Free PMO Testing](public/screenshots/pmo-testing-01.jpg){:title="Free PMO Automated Testing"}</center>
![Free PMO Testing](public/screenshots/pmo-testing-01.jpg)
Write Preview
Loading…
Cancel
Save