Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
184 changed files
with
531 additions
and
41,599 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"directory": "bower_components" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
root = true | ||
|
||
[*] | ||
indent_style = space | ||
indent_size = 4 | ||
end_of_line = lf | ||
charset = utf-8 | ||
trim_trailing_whitespace = true | ||
insert_final_newline = true | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -10,3 +10,5 @@ build.xml | |
app/css/* | ||
sdk/test/unit/index.html | ||
node_modules | ||
src/**/*.templates.js | ||
src/**/*.tpl.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
language: node_js | ||
node_js: | ||
- '0.10' | ||
before_install: | ||
- gem update --system | ||
- gem install compass --pre | ||
before_script: | ||
- export DISPLAY=:99.0 | ||
- sh -e /etc/init.d/xvfb start | ||
notifications: | ||
hipchat: | ||
rooms: | ||
secure: MkXAFdP2aBBIRhaS3XcaUxcQ17fiWrzvj3aJfsd0gMF+TA7AXZrOOzn2QaLPs2FLobiuXLuk//+CZh8p/bmmSal1WASuBkE3AfD6smvwyv7v/Td7SVGIfLfJ0e0yz2IPdB9GIkCHNv6u+3yEkLkiiYAelFnnBMERp1lblhjxKtI= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
# Contributing Guide | ||
|
||
Contributing to this repository is fairly easy. This document shows you how to | ||
get the project, run all provided tests and generate a production ready build. | ||
|
||
It also covers provided grunt tasks, that help you developing on this repository. | ||
|
||
## Dependencies | ||
|
||
To make sure, that the following instructions work, please install the following dependecies | ||
on you machine: | ||
|
||
- Node.js | ||
- npm | ||
- Git | ||
- Bower | ||
|
||
If you install node through the binary installation file, **npm** will be already there. | ||
When **npm** is installed, use it to install the needed npm packages: | ||
|
||
- bower <code>npm install -g bower</code> | ||
- grunt-cli <code>npm install -g grunt-cli</code> | ||
- karma <code>npm install -g karma</code> | ||
|
||
## Installation | ||
|
||
To get the source of this project clone the git repository via: | ||
|
||
```` | ||
$ git clone https://github.com/sofa/<component-name> | ||
```` | ||
|
||
This will clone the complete source to your local machine. Navigate to the project folder | ||
and install all needed dendencies via **npm** and **bower**: | ||
|
||
```` | ||
$ npm install | ||
$ bower install | ||
```` | ||
|
||
The project is now installed and ready to be built. | ||
|
||
## Building | ||
|
||
This repo comes with a few **grunt tasks** which help you to automate | ||
the development process. The following grunt tasks are provided: | ||
|
||
#### Grunt tasks | ||
|
||
All sofa components have the provide the same grunt tasks. These are the following: | ||
|
||
#### `grunt test` | ||
|
||
`grunt test` executes (as you might thought) the unit tests, which are located | ||
in `test/`. The task uses **karma** the spectacular test runner to execute | ||
the tests with the **jasmine testing framework**. | ||
|
||
#### `grunt build` | ||
|
||
You only have to use this task, if you want to generate a production ready build of | ||
this project. This task will also **lint**, **test** and **minify** the | ||
source. After running this task, you'll find the following files in a generated | ||
`dist` folder: | ||
|
||
```` | ||
dist/sofa.XXX.js | ||
dist/sofa.XXX.min.js | ||
```` | ||
|
||
#### `grunt watch` | ||
|
||
This task will watch all relevant files. When it notice a change, it'll run the | ||
**lint** and **test** task. Use this task while developing on the source | ||
to make sure, every time you make a change you get notified if your code is incosistent | ||
or doesn't pass the tests. | ||
|
||
## Contributing/Submitting changes | ||
|
||
- Checkout a new branch based on <code>master</code> and name it to what you intend to do: | ||
- Example: | ||
```sh | ||
$ git checkout -b BRANCH_NAME | ||
``` | ||
- Use one branch per fix/feature | ||
- Make your changes | ||
- Make sure to provide a spec for unit tests | ||
- Run your tests with `grunt test` | ||
- When all tests pass, everything's fine | ||
- Commit your changes | ||
- Please provide a git message which explains what you've done | ||
- This repo uses [Brian's conventional-changelog task](https://github.com/btford/grunt-conventional-changelog) so please make sure your commits follow the [conventions](https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit) | ||
- Commit to the forked repository | ||
- Make a pull request | ||
- Before sending a PR it's always helpful to rebase your changes against latest `master` first | ||
- Once your commits are rebased, simply send a pull request against the current `master` branch | ||
- Travis CI is watching you! | ||
|
||
If you follow these instructions, your PR will land pretty safety in the main repo! | ||
|
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.