Robot
/
HEAD
mirror of https://github.com/joshbuchea/HEAD.git
2
0
Fork 0
Code Issues Releases Wiki Activity

Improve contribution guidelines 

The previous contribution guidelines seemed to be quite vague with regard to the Jekyll based [<head> Cheat Sheet](http://gethead.info/) website.

These new guidelines help contributors understand how to contribute to the website too.
This commit is contained in:
Daksh Shah 2017-03-08 18:23:58 +05:30 committed by GitHub
parent dc87dd5823
commit 5e23d69228
1 changed files with 15 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -640,7 +640,15 @@ Example:
## Contributing
Open an issue or a pull request to suggest changes or additions.
**Open an issue or a pull request to suggest changes or additions.**
### Guide
The **HEAD** repository consists of two branches:
#### 1. `master`
This branch consists of the `README.md` file that is automatically reflected on the [\<head> Cheat Sheet](http://gethead.info/) website. All changes to the content of the cheat sheet as such should be directed to this file.
Please follow these steps for pull requests:
@ -649,6 +657,12 @@ Please follow these steps for pull requests:
- Don't include a trailing slash in self-closing elements — the HTML5 spec says they're optional
- Consider including a link to documentation that supports your change
#### 2. `gh-pages`
This branch is responsible for the [\<head> Cheat Sheet](http://gethead.info/) website. We use [Jekyll](https://jekyllrb.com/) to deploy the `README.md` Markdown file through [GitHub Pages](https://pages.github.com/). All website related modifications must be directed here.
You might want to go through the [Jekyll Docs](https://jekyllrb.com/docs/home/) and understand how Jekyll works before working on this branch.
### Contributors
Check out all the super awesome [contributors](https://github.com/joshbuchea/HEAD/graphs/contributors).