Site editing workflow

Editing pages

There are alternative workflows depending whether you have write access to the repository.

You have write access to the repository

1. Clone the sipbs-compbiol.github.io repository to your machine (if you have not done so already)
2. Confirm that you are in the master branch of your local copy of the repository, and it is up to date using git pull and/or git rebase master
3. Create a new branch for your changes with, e.g. git checkout -b <BRANCH NAME>
4. Start serving the site locally using bundle exec jekyll serve
5. Navigate a browser to http://localhost:4000/ (or whichever URL the jekyll server indicates) to check that the site renders correctly
6. Make your changes to the site
7. Check that the changes render correctly, that links work, etc.
8. git add your changes to the repository and git commit them with an informative short (and if helpful, also a long) message
9. git push your changes to the remote repository
10. Make a Pull Request for your changes in GitHub

You do not have write access to the repository

1. Fork the sipbs-compbiol.github.io repository in your GitHub account
2. Clone the sipbs-compbiol.github.io repository to your machine (if you have not done so already)
3. Confirm that you are on the master branch of your local copy of the repository and that it is up to date using git pull and/or git rebase upstream master
4. Create a new branch for your changes with, e.g. git checkout -b <BRANCH NAME>
5. Start serving the site locally using bundle exec jekyll serve
6. Navigate a browser to http://localhost:4000/ (or whichever URL the jekyll server indicates) to check that the site renders correctly
7. Make your changes to the site
8. Check that the changes render correctly, that links work, etc.
9. git add your changes to the repository and git commit them with an informative short (and if helpful, also a long) message
10. git push your changes to the remote repository
11. Make a Pull Request for your changes in GitHub against the master branch of sipbs-compbiol.github.io

Handling Pull Requests

The general workflow for handling Pull Requests is

1. Someone with write access (possibly the editor themselves, if they have write access) will review the changes
2. If more editing is required, or the changes cannot be cleanly merged, a discussion will follow on the Pull Request page, and changes made until the edits are OK
3. The changes will be merged into master