diff --git a/README.md b/README.md index 48ea800..4c1b41d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ -## felayout_t3kit_new +#felayout_bluemountain +[![Release](https://img.shields.io/github/release/t3kit/felayout_bluemountain.svg?style=flat-square)](https://github.com/t3kit/felayout_bluemountain/releases) -#### Based on `felayout_t3kit 1.0.0` +Front-End layout for [theme_t3kit_bluemountain](https://github.com/t3kit/theme_t3kit_bluemountain) project + +### [CHANGELOG](https://github.com/t3kit/felayout_bluemountain/blob/master/CHANGELOG.md) ### Required dependencies: @@ -10,15 +13,15 @@ - [Bower](http://bower.io/) >=1.7.7 `npm install -g bower` - [Grunt-cli](http://gruntjs.com/) >=0.1.13 `npm install -g grunt-cli` - ### Installation: First, clone repo: ```bash -git clone repoLink +git clone git@github.com:t3kit/felayout_bluemountain.git ``` Next, install Bower/NPM dependencies: + ```bash npm install bower install @@ -33,3 +36,60 @@ bower install - Run `grunt pushSite` to build your static site and push it to separate branch `site` - Run `grunt pushCss` to compile all Front-End service files plus **CSS** styling for CMS needs, copy it to separate branch `css` and push to remote git server. - Run `grunt pushLess` to compile all Front-End service files plus **LESS** styling for CMS needs, copy it to separate branch `less` and push to remote git server. + + + +# Contributing + +Everyone can add feedback, bug reports and fixes. Here is several rules for contribute this repository. Please keep this in mind for better cooperation. + + +## Issues + +If you have a question(feature) not covered in the documentation or want to report a bug, the best way to ensure it gets addressed is to file it in the appropriate issues tracker. Please check that you've completed the following steps: + +* Make sure you're on the right version of [dependencies](#required-dependencies) +* Make sure you're on the latest version of generator npm update -g generator-fe-kit +* Used the search feature to ensure that the bug hasn't been reported before +Included as much information about the bug as possible, including any output you've received, what OS and version you're on, etc. +* Try to reduce your code to the bare minimum required to reproduce the issue. This makes it much easier (and much faster) to isolate and fix the issue. + + +## Pull Requests + +* Please check to make sure that there aren't existing pull requests attempting to address the issue mentioned. We also recommend checking for issues related to the issue on the tracker, as a team member may be working on the issue in a branch or fork. +* Non-trivial changes should be discussed in an issue first +* Develop in a topic branch, not master +* Follow [Style Guides](#style-guides) +* Follow [Git commit conventions](#git-commit-conventions-and-output-formatting) +* Write a convincing description of your PR and why we should land it + + + +## Style Guides +This project uses special rules and style guides. Those rules you can find on appropriate files: `.jscsrc .jshintrc .htmlhintrc .csslintrc .editorconfig` + +* [htmlhint](https://github.com/yaniswang/HTMLHint/wiki/Rules) +* [jscs](http://jscs.info/rules.html) +* [jshint](http://jshint.com/docs/options) +* [csslint](https://github.com/CSSLint/csslint/wiki/Rules) +* [editorconfig](http://editorconfig.org) + + +## Git commit conventions and output formatting +Please use semantic labels for your messages, but if commit message is not very important, you can skip labels. All commits with labels will be added in CHANGELOG file, that's why it is **important to use predefined labels** on your commits. + +####Git labels: +* **[FEATURE]** A new feature +* **[FIX]** A bug fix +* **[REFACTOR]** A code change that neither fixes a bug or adds a feature +* **[PERF]** A code change that improves performance. +* **[CHORE]** Changes to the build process (grunt) or auxiliary tools and libraries such as documentation generation and linters (jshint, jscs, etc.) +* **[DOC]** Documentation only changes +* **[STYLE]** Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) +* **[TEST]** Adding missing tests +* **[UPDATE]** Updating git submodules, npm/bower dependencies + +Please ensure any pull requests of fixes **follow this closely**. If you notice existing code which doesn't follow these practices, feel free to shout and we will address this. + +***