From 5e23d69228081b1ed472c5435d5154d2f8b5d17c Mon Sep 17 00:00:00 2001 From: Daksh Shah Date: Wed, 8 Mar 2017 18:23:58 +0530 Subject: [PATCH] Improve contribution guidelines The previous contribution guidelines seemed to be quite vague with regard to the Jekyll based [ Cheat Sheet](http://gethead.info/) website. These new guidelines help contributors understand how to contribute to the website too. --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 336dc00..1388094 100644 --- a/README.md +++ b/README.md @@ -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 [\ 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 [\ 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).