Document in README how to install and use
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start by reading the existing README and running the tool's --help output. Document that installation consists of copying the files into /usr/local/bin/ or another directory on PATH, and include the help output so the installation and available usage are clear.
Written by the indexing model from the issue text.
Description
The tool itself has a pretty nice --help output, once you get to running it at all.
When coming upon the repo here on GitHub, you don't see that and instead you see the README. It'd be really helpful for that to (a) say how to install it (it's trivial, in fact -- copy the files into /usr/local/bin/ or elsewhere on your PATH -- but that needs to be written down), and (b) maybe just have a copy of the --help output, so you can see what you'll get.
- Dominant language
- Python
- Stars
- 16
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from dropbox/git-rbr
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100