Skip to content

Basic Guide to Github

Brandon edited this page Jun 18, 2017 · 2 revisions

Introduction

Here is a little guide to using the Github repository:

The Github page is:

https://github.com/EmpowermentZone/EdSharp

Latest Release

To download the latest release, either go to the quick links section of the above page and click on “download latest release” or go to the releases section of the repository which is found in the group of links under the heading “EmpowermentZone/EdSharp” in the above link. It will say something like “4 releases” and you click on that. A faster way of getting to the releases page is by going to the heading mentioned above, hitting l twice and up arrow twice. You can also just go to:
https://github.com/EmpowermentZone/EdSharp/releases

Submit a Bug or Feature Request

To submit an issue, go to the “EmpowermentZone/EdSharp” heading and arrow down twice to “Issues”. Then hit b to get to new issue. The issues are under the new issue button.
Note before posting an issue: Please ask on the email list if what you are experiencing is really a bug or if it is something else. Same goes for feature requests, see what people think before posting it in the issues. The link to the issues is:
https://github.com/EmpowermentZone/EdSharp/issues

Wikki

If you want to contribute to the Wikki, go to:
https://github.com/EmpowermentZone/EdSharp/wiki
or look at the top of this page and and add a new page.

For Coders

Cloning the Repository

If you want to make a repository on your computer so you can get the latest code and contribute, click the button that says “Clone or download this repository”, and click the “Copy to clipboard” button. Then make sure you have git installed (google it if you don’t, git versioning commandline tool) and type:
Git clone https://github.com/EmpowermentZone/EdSharp.git
And it will make a clone of the repository.

Forking Your Own Repository

If you want to make changes and merge them, you will want to click on the button that says:
Fork your own copy of EmpowermentZone/EdSharp to your account
It is above the heading that says “EmpowermentZone/EdSharp” Then you clone your forked repository and make changes to it. When you are ready to have someone look at your changes to put them into the next release, make a pull request by going to your fork and clicking on the button under the clone button that says “New pull request”. Fill out the form and click submit.