Awesome Tips about Github

Table of Contents

• Shortcuts
• Search Syntax
• Wide Github
• Chrome Extensions
• Expand outdated Github Comments
• Hackable Github URLs
• Use Github to Host Files and Share Online
• Github Pages
• Markdown
• Awesome Tips about Markdown
  • Misc
  • Related Posts

Shortcuts

• Type ? to check keyboard shortcuts.

  s or /	Focus the search bar
  g n	Go to your notifications
  g p	Go to the Pull requests tab at Repositories
  g w	Go to the Wiki tab
  t	Activates the file finder or Open the list of changed files in the pull request
  w	Switch to a new branch or tag
  l	Jump to a line in your code

Excluded URLs and keys in Chrome Vimium

• Some shortcuts from Github conflicts with Chrome Vimium

• So add the following at Excluded URLs and keys at Vimium Options.

  Patterns	Keys
  https?://github.com/*	b,l,c,g,n,h,p

---

Search Syntax

• filename:FILENAME
• in:file, in:path
• key_word in:file,path matches code where “key_word” appears in the file contents or the file path.
• Search by file location
  • path:/, path:DIRECTORY, path:PATH/TO/DIRECTORY
• extension: EXTENSION
• user:the_user, repo:the_repo
• fork:true/false/only

Wide Github

• Install Tampermonkey first.
• Add @include *github.your_company.com* at Installed userscripts -> Wide Github -> Editor to make it work with GitHub Enterprise.

Chrome Extensions

• Octotree
  • Easy-to-navigate code tree, just like in IDEs
• GitZip for github
  • It can make the sub-directories and files of github repository as zip and download it; You DO NOT have to download the whole project just for those few files/dirs you need.
• Enhanced GitHub

Expand outdated Github Comments

javascript:Array.from(documentP.getElementsByClassName('outdated-comment'))
.forEach(l => l.classList.add('open'));

---

Hackable Github URLs

• Compare changes between tags/branches
  • https://github.com/{username}/{repo}/compare/{older-tag}…{newer-tag}
  • compare/master@{2weeks}…master
  • compare/{older-tag}…{newer-tag}
• URL to create a pull request between different two branches
  • /compare/remote:branch…remote:branch
• issues to track all issue
• pulls to track all prs

Use Github to Host Files and Share Online

Github Pages

• We can use GitHub Pages to host web sites, presentation
• How to Build Presentations with reveal.js, Markdown and Github Pages
• Github pages are not updating
  • Check GitHub Pages section at settings of your Github project. There would be some error that explains why and fix it.
  • Github also sends emails with title Page build failure.

Markdown

• Use Markdown in PR, comments, check here about some awesome tips about markdown
• Quote reply to get the markdown source of PRs and comments
• To type long markdown: PR template, use Atom with markdown-writer Markdown Enhanced Preview.
  • check more
  • (/2017/10/awesome-tips-about-atom-editor.html){target=“blank”}

---

Awesome Tips about Markdown

---

Misc

• Use Gist to host code
• Pin repos
• Emoji in github
  • 👍, 👍, 🐛
• Saved replies
• Check whether project is still alive?
  • Check history of commit, release and contributors at Code tab.
  • Check Insights tab: how many contributors, code frequency, commits history etc.
  • Check issues tab: check the closed issues, how they are closed: some may be closed without any reply or auto closed.
  • For example emmet-atom looks like not maintained any more. <!– https://github.com/zhaoolee/ChineseBQB

–>

---