Contributing and Updating - LEARNAcademy/syllabus GitHub Wiki
As instructing staff of Learn Academy you may find yourself needing to contribute or otherwise update the content in the syllabus. This git workflow might be very familiar to you, but here are the steps for reference.
First, get a copy onto your machine:
- From here, navigate to the '<>Code' tab at the top left under 'LEARNAcademy/Syllabus'
- Find and click 'Clone or download' dropdown button
- Copy the link or click the clipboard button
- In terminal navigate to where you want your copy of the syllabus
- Run your
git clone <pasted url>
in the terminal
You want to start your changes on a branch:
- Run
git checkout -b name_of_branch
to create a branch for your changes - Start making your edits
- Run `git commit -am' with your commit message
- Run
git push origin name_of_branch
to push your branch to github
When you're satisfied with your changes and they're ready to be reviewed, make a pull request:
- If it's a new branch you can click the 'Compare and pull request' button or just click the 'New pull request' button
- Write a short description detailing your changes
- Click 'Create pull request'