Author

Muhammad Syehan

Date

17 Jan 2022

Source

Medium

OctoberCMS: Quality Guidelines untuk Memasarkan Modul Anda

Photo by John Schnobrich on Unsplash

Halo,

Pertanyaan pertama, sudah seberapa jauh anda memahami OctoberCMS ? inisiasi ide, instalasi MVC di plugin, dan membuat tampilan tema untuk halaman depan website anda, apakah sudah semua? selamat kalian sudah siap memasarkan modul OctoberCMS anda ke komunitas menggunakan marketplace OctoberCMS!

Namun apakah kalian sudah memakai panduan kualitas nya? Well, sebagian orang pasti melewatkan hal ini karena beberapa desakan tertentu yang berujung membuat projek anda sulit di kembangkan ataupun di pahami nanti ketika modul anda sudah di hands-on oleh developer lain.

Kalian tahu, OctoberCMS sudah membuat panduan kualitas yang komprehensif dan terstruktur lho! Semuanya sudah tercantum rapi oleh kreator dari framework tersebut pada halaman OctoberCMS Quality Guidelines disini. Namun jika kalian kesulitan memahami isi dari informasi didalamnya, artikel ini akan mencoba menjelaskan konteks penting didalam panduan tersebut. Enjoy bahasan Quality Guidelines di artikel ini yah~

Tujuan

Suatu hal common bagi sebagian pencipta framework adalah membuat ketentuan pemakaian di framework itu sendiri. OctoberCMS membuat guidelines ini bermaksud agar kita sebagai authors lebih paham dan cepat melakukan reviewing process. Dengan guidelines ini para authors akan lebih mudah menaikan kualitas produk dan ekosistem OctoberCMS sendiri di dalamnya. Dokumentasi yang sudah terbentuk disana pun masih banyak feedback dari developer diluar sana, maka dari itu sekiranya kita harus tetap up-to-date dalam guidelines yang diberikan oleh kreator, sejauh ini dokumentasi tersebut belum ada perubahan yang signifikan di dalamnya.

Editor Rights (Hak Penyunting)

Di dalam ketentuan ini, para Editor dari OctoberCMS akan melakukan perubahan pada modul plugin dan tema deskripsi dan beberapa screenshots, penyesuaian ini akan mencakup pada perbaikan grammar dan pungtuasi errors, serta improvisasi pada gaya penulisan konten dan penyusutan gambar, pada proses penyesuaian ini makna pada deskripsi tidak akan dihilangkan oleh Editor OctoberCMS

Common rejection reasons (Alasan penolakan umum)

pada dokumentasi ini, OctoberCMS memiliki beberapa alasan dasar atau umum mengapa quality guidelines anda di tolak, OctoberCMS memberikan daftar kesalahan umum nya :

  • Migrasi Database Gagal pada waktu instalasi.
  • Error Runtime (Kode pada plugin anda crash atau error).
  • Nama produk, deskripsi panjang pendek tidak memadai, tidak akurat, penulisan yang kurang format dan tidak relevan dengan fungsionalitas produk.
  • Ikon produk atau screenshots tidak sesuai dengan aturan.

Developer Guide (Panduan Pengembang)

Salah satu dari beberapa ketentuan OctoberCMS agar memenuhi kriteria Quality Guidelines terpenuhi. Sebagai developer kita di haruskan untuk mengikuti panduan pengembang juga. Jika tidak diikuti akan menjadi hambatan.

Author Names (Penamaan Sang Pengarang)

Simply, penamaan pengarang ini tidak menduplikasi nama pengarang lain, seperti mengganti beberapa karakter namun ejaan nya tetap sama. Terakhir penamaan ini tidak boleh menyangkut dengan nama CMS atau platform blog lain.

Common requirements to new products (Kebutuhan umum untuk produk baru)

Hakikatnya module ini untuk membantu menyelesaikan masalah yang spesifik. Namun jika ada cara lebih mudah yang disuguhkan oleh OctoberCMS sendiri, kemungkinan akan di tolak oleh pihak berwenang. Last but not least, modul baru dengan metode penyelesaian yang sama dengan modul yang sudah beredar, akan dipertimbangkan untuk ditolak oleh Aggregator OctoberCMS.

Developer Tools (Sebagai alat bantuan Pengembang)

Perlu diingat, alat yang kalian promosikan baiknya tidak mendukung untuk mengubah source code lain baik dari core nya ataupun dari eksternal modul lain, dengan begitu kalian sama-sama mendukung komunitas lain untuk terus berkembang bersama. Alangkah indah jika promosi module anda lebih kepada mekanisme dan mengarah ke problem solving dari modul itu atau bahkan saling melengkapi kepada plugin tertentu diluar sana. Pengguna langsung baiknya tidak dipaksakan untuk mengupdate modul lain jika ingin menggunakan modul kita.

Describing your products (Penjelasan produk)

modul kalian pasti dong harus dibuatkan nama, deskripsi pendek maupun panjang dan juga pendokumentasiannya. Salah satu panduan OctoberCMS yang cukup panjang aturan yang berlaku. Disini saya mencoba untuk meringkas nya agar lebih cepat untuk memahami apa saja batasannya :

  • Disarankan agar proper dalam penulisan bahasa inggris tanpa adanya kesalahan grammar
  • Heading, diusulkan tidak ada pertebalan kata di heading nya
  • Hindari paragraf pendek, pertimbangkan menggunakan penulisan menggunakan listing jikalau sifatnya spesifik
  • Demi keamanan, sintaks HTML tidak di implikasikan ke produk deskripsi.
  • Deskripsi pendek diharapkan terarah dan mengekspresikan manfaat modul kalian.
  • Deskripsi panjang jabarkan cara kerja modul kalian, pengkonfigurasiannya, dan pastikan developer lain paham dalam pengoperasiannya
  • Jikalau ada bahasa asing (diluar dari bahasa inggris), diingatkan pada deskripsi panjang yapp..
  • Dokumentasi modul kalian harus lebih padat dan memadai sebisa mungkin untuk para pengembang yang menggunakannya, deskripsikan apa yang disajikan dari modul mu dan bagaimana cara penggunaan properties & variable didalamnya ketika melakukan injeksi ke projek.
  • Penulisan contoh untuk kode front-end baiknya tanpa css (terkecuali itu dibutuhkan)
  • Jika ada dependensi modul, wajib banget untuk dicantumkan pada deskripsi panjang, menandakan para user sebelum mereka meng-install modul kita.

Code and functionality (Kode dan Fungsinya)

Module akan bekerja jika kodingan kita bersih dari serangga, betul kan? Nah aturan guideline OctoberCMS mengisyaratkan kembali agar kodingan dan fungsionalitas module kita haruslah jalan sebaik mungkin secara end-to-end. Beberapa teguran dari guidelines nya yaitu :

  • Harus tidak ada error ketika instalasi modul!
  • Bug antar front-end dengan back-end baiknya tidak timbul, cek kembali segera mungkin.
  • Modul tidak mengandung kodingan yang mengancam keamanan pada sistem.
  • Kode harus berkualitas dan terkonfirmasi dengan modern coding standards. Harus diterapkan tapi tidak terlimitasi cukup proper dalam format kode, proper penggunaan pola MVC, dan konseptualisasi OctoberCMS yang sudah terdeskripsi pada dokumentasinya.
  • Untuk Modul Tema, pastikan tidak ada file type PHP dan Composer didalamnya.
  • Modul Tema tidak boleh ada direktori node_modules atau bower, yang kita tau isian node_modules akan banyak dan membesarkan ukuran repository. Kalian harus bikin lock file yang bisa menunjang css anda dengan bantuan command executor nantinya.

Screenshots

Jujur saya agak lelah baca pada bagian ini, dokumentasi ini punya validasi yang banyak, sejauh ini tidak semua validasi diharuskan konkrit mengikuti guidelines screenshots ini, dan yang cukup kalian pertimbangkan adalah :

  • File ekstensi konvensional ; jpeg, jpg, png, dll.
  • Ukuran file sebisa mungkin kecil.
  • Relevan dengan produk anda dan step by step penggunaan modul anda.
  • Ukuran pixel screenshot maksimal 800x600px untuk plugin screenshot atau 990x600px untuk tema. lebar mereka berdua tidak boleh lewat dari 1200px.
  • Tidak ada elemen browser terpampang dalam screenshots.
  • Maksimal melampir screenshots hanya 5.

Icons

Akan kece jika modul anda mempunyai icon yang merepresentasikan filosofi modul kalian yakann. Simak bagian ini agar icon anda sesuai aturan :

  • background transparan menggunakan file type PNG.
  • ukuran original tinggi x lebar 64x64px

moreover, let ur creativity play

Tell us your story,
we would like to understand
your problem better

Get in Touch
buble chat