This repo is a monorepo for the @olavea/gatsby-theme-picture-book
It includes:
- a the theme (located in
theme/
) - a demo site (located in
demo/
) - a Yarn workspaces configuration so the theme and demo can be worked on simultaneously
TODO: Document coding style and more of the workflow to welcome #codenewbies.
- Clone the repo
- Run
yarn
to install dependencies - Run
yarn workspace demo develop
to run the demo site
- Create a new branch
git checkout -b <your branch name>
- Make sure you first checkout the master branch and then pull the latest changes:
git checkout master
and thengit pull
- If you are working on an issue add the issue number to the branch name
- Example: `git checkout -b shorter-theme-name-#2``
- Make sure you first checkout the master branch and then pull the latest changes:
- Commit often as you go along
git commit -a -m <commit message>
commits all changed files.
- Push to GitHub every now and then
git push
. - When satisfied or in need of input create a Pull Request.
- IMPORTANT: Do not create the pull request toward Jason's repo, but this repo!
- Make sure the Pull Request is running as it should on Netlify before merging to master.
- If there are many small "ugly" commit do a "Squash and merge" and clean up the commit message.