We welcomes new contributors.
This document will guide you through the contribution process.
Fork the project on GitHub and check out your copy locally.
For developing new features and bug fixes, the
master branch needs to be pulled
and built upon. We follows a Continuous Integration
model, where the master branch is always deployed to production.
Create a feature branch and start hacking:
$ git checkout -b my-feature-branch -t origin/master
Make sure git knows your name and email address:
$ git config --global user.name "J. Random User" $ git config --global user.email "email@example.com"
Writing good commit logs is important. A commit log needs to describe what changed and why. Follow these guidelines when writing one:
A good commit log can look something like this:
explaining the commit in one line Body of commit message is a few lines of text, explaining things in more detail, possibly giving some background about the issue being fixed, etc. etc. The body of the commit message can be several paragraphs, and please do proper word-wrap and keep columns shorter than about 72 characters or so. That way `git log` will show things nicely even when it is indented.
The header line needs to be meaningful; it is what other people see when they
git shortlog or
git log --oneline.
git rebase (not
git merge) to sync your work from time to time.
$ git fetch upstream $ git rebase upstream/master
$ git push origin my-feature-branch
Go to https://github.com/yourusername/static-site and select your feature branch. Click the ‘Pull Request’ button and fill out the form.
Pull requests are usually reviewed within a few days. If there are comments to address, apply your changes in a separate commit and push that to your feature branch. Post a comment in the pull request afterwards; GitHub does not send out notifications when you add commits.
By making a contribution to this project, I certify that: