William & Mary's Society of Women in Computing Chapter Website

Maintenance Walkthrough

(Of course if you had the right permissions, you could directly edit the website and push to master, but these instructions are written for the more general SWC body who may not have write permissions.)

Prerequities: Github account, read access to wmswc/wmswc.github.io

1. Fork the repository

2. Clone the website onto your machine

with ssh:

$ git clone git@github.com:<USERNAME>/wmswc.github.io.git

with html:

$ git clone https://github.com/<USERNAME>/wmswc.github.io.git

3. Go to your cloned repository

$ cd wmswc.github.io/

4. Add the original repository as a remote, "upstream"

$ git remote add upstream git@github.com:wmswc/wmswc.github.io.git

In the future, you might want to get the remote's changes using:

$ git fetch upstream
$ git merge upstream

5. Make a branch for your changes
   • here we will make (-b) and move onto (checkout) a new branch (your-branch-name) which is based on the branch master from our original repository (upstream)

$ git checkout -b your-branch-name upstream/master

6. Make changes

7. Commit your changes
   For example:

$ git add --all
$ git commit -m "short description of changes"
$ git push -u origin your-branch-name

8. Create a pull request
   One way to do this is by

   1. Clicking on 'New pull request' on pull request tab of the original repo
   2. Clicking 'compare across forks'
   3. Selecting your fork and selecting your changes' branch from the dropdowns
   4. Clicking 'Create pull request'
   5. Editing the title and description of your pull request, then submitting it

9. Ask someone with write permissions to approve and merge your pull request