Skip to content

Commit

Permalink
hub: overhaul the page for improved clarity (tldr-pages#1202)
Browse files Browse the repository at this point in the history
- make main description and command descriptions more specific
- simplify the fork command description
- simplify the pull-request example (both the command and description) hopefully without sacrificing information
- replace the browse issues example (which opens a page in the web browser) with one create a github remote for the current repo
  • Loading branch information
waldyrious committed Dec 21, 2016
1 parent 25a9e6d commit 9a0a033
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions pages/common/hub.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
# hub

> A command-line wrapper for git that makes you better at GitHub.
> A wrapper for git that adds commands for working with github-based projects.
> The commands can also be used using "git" instead of "hub".
- Clone a repository you own:
- Clone a repository you own, using just the repository name rather than the full URL:

`hub clone {{repo_name}}`

- Clone another user's repository:
- Clone another user's repository, using their github username and the repository name:

`hub clone {{github_username}}/{{repo_name}}`
`hub clone {{username}}/{{repo_name}}`

- Fork your own copy of a repository cloned from another user (must be in the cloned repository folder, creates a remote named after your GitHub username):
- Create a fork of the current repository (cloned directly from another user) under your github profile:

`hub fork`

- Create a pull request from your fork (first pushing the changes to your fork remote, named after your GitHub username):
- Create a pull request of the current branch in the upstream project (after sending the changes to your fork on github):

`git push {{your_github_username}} {{current_branch}} && hub pull-request`
`hub pull-request`

- Open the current project's issues page:
- Upload the current repository to your github account:

`hub browse -- issues`
`hub create`

0 comments on commit 9a0a033

Please sign in to comment.