-
-
Notifications
You must be signed in to change notification settings - Fork 19
Contributing
The master branch is kept clean by putting extra information into the gh-pages branch and hosting the demo site from that.
- There is no index.html in the master branch
- There is no CNAME file in the master branch
- There are no images in the master branch
The install instructions suggest downloading the latest version of the neat.html and neat.css files from the demo site but you can also download the latest release from Github. The demo site is hosted from the gh-pages branch and the download is a clean copy of master at a specific release tag.
In order to do a release you'll need to do the following.
- Update the download link in the neat.html file
- Create a new release on Github for the master branch
- Update the gh-pages branch with the latest version
Here are the steps to update the neat.html file.
- Checkout the master branch with
git checkout master - Edit the neat.html file and update the link, version, and date
- Commit the change with
git commit -m "Update the version number, link, and date" - Push the change with
git push
Here are the steps to update the gh-pages branch for the demo site. These are from memory and may need refinement.
- Checkout the gh-pages branch with
git checkout gh-pages - Merge master into gh-pages with
git merge master --no-edit - Copy the neat.html file over index.html with
cp neat.html index.html - Commit the changes with something like
git commit -m 'Add cool feature' - Push the changes back to github with
git push
Here are the steps to tag and release the master branch for the downloads links.
- Checkout the master branch with
git checkout master - Create an annotated tag for the release with something like
git tag -a v0.0.2 -m "v0.0.2" -m "Version 0.0.2 release of Neat." - Push the tags to origin with
git push --tags
The ipsum branch exists as a copy of neat with ipsum text just for the screenshot that is used on the demo site. Use this site if anything changes that affects the first view and you need to update the screenshot. The neat documentation pulls the image from neat.joeldare.com directly.
- Checkout the ipsum branch with
git checkout ipsum - Merge master into gh-pages with
git merge master - Take the new screenshot and save it
- Resize the screenshot to 800px wide and less than 100k
- Checkout the gh-pages branch with
git checkout gh-pages - Save the new screenshot into images/neat-screenshot.png
- Add the new image to git with
git add images/neat-screenshot.png - Commit the change with something like
git commit -m 'Update the screenshot' - Push the changes back to github with
git push