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.

Sign up for GitHub

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

Jump to bottom

Create clearer Readme #1

Open
7 tasks done
charsme opened this issue Jun 29, 2018 · 2 comments
Open
7 tasks done

Create clearer Readme #1

charsme opened this issue Jun 29, 2018 · 2 comments
Assignees
@charsme @lordhasyim @kennykarnama @setiawanYusuf
Labels
documentation Documentations Related label good first issue Good for newcomers help wanted Extra attention is needed

Comments

@charsme
Copy link
Contributor

charsme commented Jun 29, 2018 •
edited
Loading

Readme harus sesuai dengan isi repo. Butuh dijabarkan dengan lebih detail. Yang butuh di include kan.

  • Description dari sdk nya
  • Constraint penggunaan, limitasi versi php dan extension yang dibutuhkan
  • Cara retrieve release version dan constraint versi sdk. Installation
  • Basic usage dari package nya
  • Integrasi badge CI/CD dan status build tiap release sama badge latest version dari package nya
  • Tambahin di readme cara pake package nya misal mau manual git clone
  • Tambah section di readme untuk proses sebelum commit dan PR, running cs-fix, cek scrutinizer, fix all patches dan rebase.
@charsme charsme mentioned this issue Jun 29, 2018
Open
4 tasks
@charsme
Copy link
Contributor Author

charsme commented Jun 29, 2018 •
edited
Loading

Installation usage could use this syntax composer require kly/onesdk tag already updated to v1.1.5

@charsme charsme added help wanted Extra attention is needed good first issue Good for newcomers documentation Documentations Related label labels Jun 29, 2018
@charsme
Copy link
Contributor Author

charsme commented Jul 25, 2018

@kennykarnama Tolong bantu readme dulu ya. Bisa bagian basic usage untuk sdk nya. Declare publisher, create Article, attachment dan semacamnya.

Lalu untuk constrain php minim versi 5.3.3

Untuk cara retrieve release coba pelajari cara require package berdasarkan version constraint. Bisa langsung di readme nya.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@charsme charsme

@lordhasyim lordhasyim

@kennykarnama kennykarnama

@setiawanYusuf setiawanYusuf

Labels
documentation Documentations Related label good first issue Good for newcomers help wanted Extra attention is needed
Projects
ONE SDK roadmap
Status: Done
Milestone
No milestone
Development

No branches or pull requests
4 participants
@charsme @lordhasyim @kennykarnama @setiawanYusuf