search

bugmark / bugmark_cl

Bugmark Command Line Client
0 stars 3 forks source link

Add CLI documentation #33

Open andyl opened 6 years ago

andyl commented 6 years ago

Add CLI documentation. Repo is bugmark/bmx_cl_ruby.

GeorgLink commented 6 years ago

Can you give more information on how one can help?

andyl commented 6 years ago

Look in the command directory and you will find all of our command classes. For each command there are places to add desc, long_desc and option documentation. You can look at existing documentation for usage examples, and there are more code examples on the Thor website. http://whatisthor.com/ (we use Thor as our command runner)

ALSO: the README file could use an overview writeup...

GeorgLink commented 6 years ago

Thanks @andyl

hritvi commented 6 years ago

hey @andyl! can i work on this?

andyl commented 6 years ago

@hritvi yes - plz coordinate w/Georg so that one person is working on this at a time.

GeorgLink commented 6 years ago

@hritvi go right ahead. I suggest we push our changes regularly to our fork so that I can see what each other are working on. Additionally, small pull requests with focused improvements will help coordinate our efforts.