Github Cheat Sheet

["Durfey, Ryan" <Ry...@comcast.com>]

Create a github issue cheat sheet https://cwiki.apache.org/confluence/display/TC/Github+Cheat+Sheet


Github Issues Cheat Sheet

  *   Projects:
     *   Container for issues, a good example would be a component like "Traffic Router'
     *   Projects allow for the creation of Kanban boards to organize issues
     *   Never complete, no progress bar
     *   Issues can belong to multiple projects
     *   Project Boards
        *   Support issues, pull requests, notes
        *   Columns are customizable and used to delineate workflow state
  *   Milestones:
     *   Container for issues like a sprint or release
     *   issue can only belong to one milestone
  *   Assignees:
     *   Only one person can be assigned
  *   Labels:
     *   supports multiple color coded labels
     *   Use for key words (api_route, crconfig, url_signing, etc...)
     *   Use for types (bug, feature, task, etc...)
     *   Use for priority or severity (p1, p2, p3, etc..)
  *   @mentions:
     *   An @mention in a ticket notifies the user
     *   You can create groups of users under an organization, for example "@apache/traffic_control"
  *   Issue Mentions (by number)
     *   When you put "#42" in a ticket it will add a reference in the referenced ticket
     *   Close/Fix
        *   By prefacing your commits with “Fixes”, “Fixed”, “Fix”, “Closes”, “Closed”, or “Close” when the commit is merged into master, it will also automatically close the issue.
        *   "Fixes #42" would would trigger the close of #42 when a commit is made
     *   Duplicates
        *   "Duplicate of #42"  add this text to issues
        *   Click undo in timeline to remove this marker
  *   Issue State
     *   Github only supports two states open/closed
  *   Task List in an issue
     *   To create a task list, preface list items with [ ]. To mark a task as complete, use [x].
     *   - [x] Finish my changes
     *   - [ ] Push my commits to GitHub
     *   - [ ] Open a pull request

  *   Search Examples
     *   Search Guide: https://help.github.com/articles/using-search-to-filter-issues-and-pull-requests/
     *   Status
        *   is:closed
        *   is:open
     *   Type
        *   type:issue
        *   type:pr
     *   Label
        *   label:"bug"
        *   no:label
     *   Milestones
        *   milestone:milestone_name
        *   no:milestone
     *   People
        *   mentions:username
        *   commenter:username
        *   assignee:username
        *   no:assignee
        *   author:username
        *

     *   Projects
        *   project:github/57
        *   no:project
     *   Dates
        *    created:<2011-01-01
        *    updated:<2011-01-01


Ryan Durfey
Sr. Product Manager - CDN | Comcast Technology Solutions
1899 Wynkoop Ste. 550 | Denver, CO 80202
M | 303-524-5099
ryan_durfey@comcast.com<ma...@comcast.com>
CDN Support (24x7): 866-405-2993 or cdn_support@comcast.com<ma...@comcast.com>