Skip to content

Commit

Permalink
update githubissues.md (fixes open-learning-exchange#395) (fixes open…
Browse files Browse the repository at this point in the history
  • Loading branch information
IshanSoni authored and aberdean committed Dec 15, 2016
1 parent 4d0e323 commit ae61917
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions pages/githubissues.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,16 @@ First, you will need to open an issue within the right repository ([upstream rep

After this, you will then research the possible solutions or ideas on how to address the issue and write a comment with this information, as you can see [here](https://github.com/open-learning-exchange/open-learning-exchange.github.io/issues/15). Someone else will hopefully provide input (as Dogi did here) and then you can move ahead with making the proposed changes.

Every time you start to work on an issue you need to create a branch to keep your work on various issues separate from each other. Before you create your branch, sync your repo following the process in the [previous step](http://open-learning-exchange.github.io/#!pages/gitandrepositories.md). Then use `git checkout -b name_of_your_new_branch --track origin/name_of_your_new_branch` to create and switch to a new branch.
Every time you start to work on an issue you need to create a branch to keep your work on various issues separate from each other. Before you create your branch, sync your repo following the process in the [previous step](http://open-learning-exchange.github.io/#!pages/gitandrepositories.md). Then use `git checkout -b name_of_your_new_branch` to create and switch to a new branch on your local repository.

**TIP**: The default branch in your repository is called master. Keeping the master branch clean of any changes is a good practice so if you make any changes you dont want, you may revert back.

Now you can go and make the proposed changes to your local files.

**NOTE**: It's important that you are on the new branch, make sure you are on the correct branch with `git checkout branch-name` before committing. Use `git branch` to make sure you are on the correct branch.

After you are done making your changes use the command `git status`. If the list of files changed only includes those you wish to modify, use the command `git add .` (The '.' is part of the command.) Otherwise you can also choose only certain changes to include by using `git add <file1> <file2> <file3>...` Now that you have selected the files you wish to include, use the commands `git commit -m "commit message"` and `git push origin name_of_your_new_branch` to save your changes and push them to your Github.
####Creating a commit
After you are done making your changes use the command `git status`. If the list of files changed only includes those you wish to modify, use the command `git add .` (The '.' is part of the command.) Otherwise you can also choose only certain changes to include by using `git add <file1> <file2> <file3>...` Now that you have selected the files you wish to include, use the commands `git commit -m "commit message"` and `git push -u origin name_of_your_new_branch` to save your changes and push them to your Github (for any further commit on the same branch after the first one, you can just use `git push`).

You can view your changes by going to <code>https://<b>rawgit.com</b>/YourUserName/YourUserName.github.io/YourBranchName/#!index.md</code> and viewing the page(s) you have changed. If everything looks correct, you are ready to create a pull request. Please remember to include the issue it is solving (for example, if your pull request fixes the issue number 320, then add `#320` to your pull request).

Expand Down

0 comments on commit ae61917

Please sign in to comment.