Skip to content

Using github

Jump to bottom Edit New page
Phil Duby edited this page Oct 27, 2018 · 4 revisions

Working with wcrsyyc on github

Summary. Follow footnote (and other) links for more details.

  • web browser
    • login to github
    • change dashboard context to WCRSyyc 1
    • choose repository to work with 2
      • Browse issues ¦ add issues ¦ add comments ¦ browse wiki ¦ add to and change wiki content ¦ Fork repository
  • local repository 3 ¦ tools 4

Footnotes:

  • (1) The user name at the top of the left column of the github login page is a drop down. Select WCRSyyc from that. ↩

  • (2) A few repositories are pinned at the top of the Western Canadian Robotics Society organization page. Links to others are shown below that. Click a link to go to the root (code tab) for the repository ↩

  • (3) A local repository is one stored on your own computer. This can be completely standalone with no external references. It can also be a copy of one from github (or elsewhere), that can be modified locally, and synchronized with the external copy. For wcrs repositories, the most convenient approach is to first create a new repository for the WCRSyyc organization, then clone that (nearly) empty repository to work with locally. It is also possible to create any empty local repository, then associate it with an empty github repository later. That is a bit more involved ↩

  • (4) Various applications can be used to work with local repositories, including creating them as clones of repositories on github. Those programs can be unique to the particular user environment (operating system). The basic git command line is available almost everywhere, so that is what will be described here. To use it, open a terminal (shell) window, then browse (change directory) to the folder that contains the repository. When creating a new local repository, either completely new, or as a copy from github, browse to the folder that is to contain the folder for the repository. Creating the repository will automatically create the folder to hold it ↩

  • (5) Cloning a git repository is done from the location the copy of the repository is to be stored.

git clone «repository-source»

When the repository to be cloned is on github, repository-source is a URL pointing the repository on github. To get that, browse to the repository home page. You do not need to be logged in to do that. You can start from the WCRSyyc organization page, then follow the link to the desired repository. Click the green Clone of download button on the code tab. If the popout does not show Clone with HTTPS, click Use HTTPS. Finally click the folder icon at the right of the single line text box. That will copy the complete repository path into your clipboard. In your terminal window, type git clone , including a trailing space character, then paste the repository URL and press the enter (or return) key. Usually, right click (ctrl click on Mac) in the terminal window will show a context menu that can be used to paste. ↩

  • (6) Using a fork of a repository to update WCRSyyc content needs more steps, but provides better control of how and when changes are actually merged into the main WCRSyyc repository. Any github user can clone or fork a public repository. Only authorized accounts can push changes back to organization repositories. However, the user forking a repository can push updates to their own copy on github, then request to merge their changes back into the WCRSyyc repository. Authorized WCRSyyc members can then apply or reject the pull request. Or add comments to the request, to ask for additional changes before approving the merge ↩

Reference:

github login page

The following information is specific to the latest beta of the github dashboard, as of 2018/10/25. Your view could be somewhat different, depending on your account configuration.

When first logging in to github, the initial page will show information about your personal activities and github account. Your user name and selected avatar icon will be at the top-left of the page. Below that will be links to repositories you have worked with (somewhat) recently. If you have been working with a repository recently, it will probably show up in that list. At the bottom will be links to any teams you are a part of.

On the right side is activity information. The top part, recent activity, shows a log of some things you have actively done recently. The log below that shows changes involving repositories that you own or are watching.

Clicking the github hub icon (the cat in a circle) at the very top (left) of most github pages will bring you back to this page.

Click your user name at the top left (below the github icon) to change the dashboard context. This is an easy way to tell github that you are currently intending to work as a member of a organization you belong to, instead of with your personal repositories. Select WCRSyyc. This will show the same types of information, but now specific to the WCRSyyc organization. Click on View organization to get to the WCRSyyc repositories home page. All existing WCRS repositories can be accessed from there. New repositories can be created as well.

Alternatively, you can click on one of the repository names to go directly to the code tab for that repository ↩

github repository home page

On a repository home page, the row below the breadcrumb path shows tabs to different views available in that specific repository. The Code view shows actual files and folders that are part of the repository with the content of the README.md file at the bottom. The other main views (tabs) for typical usage are Issues and Wiki. Assuming those are enabled for the repository.

The Issues tab is the place to go to see, add to, comment on, or manage any problems or questions related to the repository. Anyone that has a github account, and has the path (URL) to the repository can add or comment on issues here. Users with more privileges can act as moderators to the content.

The Wiki tab contains information that can be, with appropriate authorizations, changed interactively from a web browser. Anyone with a github account can view wiki information for any public repository. All WCRSyyc repositories are public. Private repositories on github need a paid account. To get access to make changes to the wiki content, ask us through email, in person at a Saturday morning gathering at the Museum, on Facebook, or by posting an issue ↩

Add a custom footer
Add a custom sidebar
Clone this wiki locally