Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Kalimat kontradiktif pada CONTRIBUTING.md #196

Closed
sensasi-delight opened this issue Dec 17, 2022 · 2 comments
Closed

Kalimat kontradiktif pada CONTRIBUTING.md #196

sensasi-delight opened this issue Dec 17, 2022 · 2 comments

Comments

@sensasi-delight
Copy link
Collaborator

Selain menggunakan gaya penulisan PSR-12 untuk implementasi kode pada Basic Learning. Ada ketentuan konsistensi yang harus Kamu terapkan yaitu:

  • Setiap materi pembelajaran berada pada folder tersendiri yang dinamai dengan materi yang berkaitan
  • Folder materi memiliki penomoran diawal sebagai prefix
  • Artikel penjelasan ditulis di README.md pada setiap folder materi. jadi kamu perlu membuat README.mdnya
  • Penamaan variabel dan fungsi menggunakan snake_case

Pada file CONTRIBUTING.md terdapat paragraf seperti yang dikutip di atas. Namun pada PSR-12, contoh kode dituliskan dengan menggunakan Camel Case dan bukan Snake Case. untuk dapat berkontribusi saya harus menggunakan gaya yang mana?

terima kasih.

@wildanie12
Copy link
Member

Ada unsur ambigu yang ditulis pada CONTRIBUTING.md. Pada awalnya penamaan dengan gaya snake_case merupakan custom rule khusus untuk kategori basic dari repository ini. Hal ini bertujuan untuk penyelarasan dengan style & function-function PHP ketika menggunakan paradigma prosedural yang menggunakan penamaan snake_case juga. Sejatinya ini merupakan sebuah pengecualian dari banyak style dan convention yang ditentukan oleh PSR-12

Mungkin lebih tepat jika salah satu petunjuk di CONTRIBUTING.md menyatakan

Jika menggunakan paradigma prosedural, gunakan snake_case
Jika menggunakan paradigma pemrograman berorientasi objek, bisa gunakan pascalCase
(meskipun factory provider yang menginstantiasi tetap ditulis dalam prosedural)

Kita bakal update lagi untuk CONTRIBUTING.md ya. Sementar kita tempatkan dalam backlog terlebih dahulu.

@sensasi-delight
Copy link
Collaborator Author

terima kasih banyak atas tanggapannya yang membuahkan penyempurnaan #197. karena hal itu issue ini saya tutup.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants