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

Add CLI documentation #33

Open
andyl opened this issue Feb 27, 2018 · 6 comments
Open

Add CLI documentation #33

andyl opened this issue Feb 27, 2018 · 6 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@andyl
Copy link
Contributor

andyl commented Feb 27, 2018

Add CLI documentation. Repo is bugmark/bmx_cl_ruby.
@andyl andyl added help wanted Extra attention is needed good first issue Good for newcomers labels Feb 27, 2018
@GeorgLink
Copy link
Collaborator

Can you give more information on how one can help?

@andyl andyl mentioned this issue Mar 5, 2018
Open
3 tasks
@andyl
Copy link
Contributor Author

andyl commented Mar 5, 2018 •
edited
Loading

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
Copy link
Collaborator

GeorgLink commented Mar 5, 2018 via email

@hritvi
Copy link
Collaborator

hritvi commented Mar 5, 2018

hey @andyl! can i work on this?

@andyl
Copy link
Contributor Author

andyl commented Mar 5, 2018

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

@GeorgLink
Copy link
Collaborator

@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.

@andyl andyl assigned andyl and unassigned andyl Mar 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@andyl @GeorgLink @hritvi