diff --git a/.gitignore b/.gitignore index 7b9e66caf1..ca23db9e8a 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,7 @@ build dist node_modules +coverage npm-debug.log # Signing Identity diff --git a/.jshintrc b/.jshintrc index 9240a3ae9f..daeaf45072 100644 --- a/.jshintrc +++ b/.jshintrc @@ -27,5 +27,5 @@ "jest": true, "pit": true }, - "predef": [ "-Promise" ] + "predef": [ "Promise" ] } diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000000..8d530885bf --- /dev/null +++ b/.travis.yml @@ -0,0 +1,12 @@ +language: node_js +node_js: + - "0.10" + +sudo: false + +cache: + - resources + - node_modules + +after_success: + which ./node_modules/coveralls/bin/coveralls.js && cat coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2f2537d80d..3fe22bdc17 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,12 +6,30 @@ Before you fil an issue or a pull request, quickly read of the following tips on ## Table of Contents + - [Development](#development) - [GitHub Issues](#github-issues) - - [Pull Requests](#submitting-pull-requests) + - [Pull Requests](#pull-requests) - [Code Guidelines](#code-guidelines) - [Testing](#testing) - [License](#license) +### Development + +- `npm install` + +To run the app in development: + +- `npm start` + +### Building & Release + +- `npm run release` + +### Unit Tests + +- `npm test` + + ## GitHub Issues Please try and label any issue as: @@ -35,6 +53,10 @@ We're thrilled to receive pull requests of any kind. Anything from bug fix, test That said, please let us know what you're planning to do! For large changes always create a proposal. Maintainers will love to give you advice on building it and it keeps the app's design coherent. +### Pull Request Requirements: +- Tests +- [Signed Off](https://github.com/docker/docker/blob/master/CONTRIBUTING.md#sign-your-work) + ## Code Guidelines ### Javascript diff --git a/README.md b/README.md index a04fc308fc..84d453e802 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ [](https://circleci.com/gh/kitematic/kitematic/tree/master) +[](https://coveralls.io/r/kitematic/kitematic?branch=master) [](http://app.bithound.io/kitematic/kitematic) +[](https://gitter.im/kitematic/kitematic?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)  -Kitematic is a simple application for managing Docker containers on Mac OS X. +Kitematic is a simple application for managing Docker containers on Mac OS X and Windows (coming soon!). ## Installing Kitematic @@ -13,21 +15,23 @@ Kitematic is a simple application for managing Docker containers on Mac OS X. Kitematic's documentation and other information can be found at [http://kitematic.com/docs](http://kitematic.com/docs). -### Development +## Bugs and Feature Requests -- `npm install` +Have a bug or a feature request? Please first read the [Issue Guidelines](https://github.com/kitematic/kitematic/blob/master/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/kitematic/kitematic/issues/new). -To run the app in development: +## Roadmap & Contributing -- `npm start` +We welcome all pull requests and contributions that anyone would like to make. The Kitematic team is super happy to support anyone who wants to get involved. Please checkout our [roadmap](ROADMAP.md) that we keep up to date for ideas to help you with contributing. We would love to talk to you about contributing. Please ask us questions and discuss contributions on our [dedicated contributors forum](https://dev.dockerproject.com/c/kitematic). -### Building the Mac OS X Package +Please read through our [Contributing Guidelines](https://github.com/kitematic/kitematic/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development. -- `npm run release` +## Community -### Unit Tests - -- `npm test` +- For questions on how to use Kitematic, see our [user forum](https://forums.docker.com/c/kitematic). +- **#kitematic** on IRC. [Join the channel](http://webchat.freenode.net/?channels=%23kitematic&uio=d4). +- Join the Kitematic [Gitter Channel](https://gitter.im/kitematic/kitematic) +- Follow [@kitematic on Twitter](https://twitter.com/kitematic). +- Read and subscribe to [the Kitematic Blog](http://blog.kitematic.com). ## Uninstalling @@ -38,23 +42,6 @@ To run the app in development: rm -rf ~/Library/Application\ Support/Kitematic ``` -## Bugs and Feature Requests - -Have a bug or a feature request? Please first read the [Issue Guidelines](https://github.com/kitematic/kitematic/blob/master/CONTRIBUTING.md#using-the-issue-tracker) and search for existing and closed issues. If your problem or idea is not addressed yet, [please open a new issue](https://github.com/kitematic/kitematic/issues/new). - -## Roadmap & Contributing - -We will be accepting pull requests that help with our [roadmap](ROADMAP.md). - -Please read through our [Contributing Guidelines](https://github.com/kitematic/kitematic/blob/master/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development. - -## Community - -Keep track of development and community news. - -- Follow [@kitematic on Twitter](https://twitter.com/kitematic). -- Read and subscribe to [The Kitematic Blog](http://blog.kitematic.com). - ## Copyright and License Code released under the [Apache license](LICENSE). diff --git a/ROADMAP.md b/ROADMAP.md index 5e85569825..35adb0cbc6 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -1,7 +1,5 @@ ## Kitematic Roadmap -We will be accepting pull requests that help with our roadmap. - **January 2015** * Automatic updates diff --git a/circle.yml b/circle.yml index 0ddf9ac841..9933147169 100644 --- a/circle.yml +++ b/circle.yml @@ -5,3 +5,6 @@ dependencies: cache_directories: - "resources" - "node_modules" +notify: + webhooks: + - url: https://coveralls.io/webhook diff --git a/images/button-restart.png b/images/button-restart.png index 69f030d3ec..0cf9ae43ce 100644 Binary files a/images/button-restart.png and b/images/button-restart.png differ diff --git a/images/button-restart@2x.png b/images/button-restart@2x.png index c710010d35..bb62729cb3 100644 Binary files a/images/button-restart@2x.png and b/images/button-restart@2x.png differ diff --git a/images/button-terminal.png b/images/button-terminal.png index e64a22aa5e..cfcedd974f 100644 Binary files a/images/button-terminal.png and b/images/button-terminal.png differ diff --git a/images/button-terminal@2x.png b/images/button-terminal@2x.png index be2c92fa24..658786d3f6 100644 Binary files a/images/button-terminal@2x.png and b/images/button-terminal@2x.png differ diff --git a/images/button-view.png b/images/button-view.png index 4d67f928f4..0eb0c2e5bd 100644 Binary files a/images/button-view.png and b/images/button-view.png differ diff --git a/images/button-view@2x.png b/images/button-view@2x.png index a445545558..9a9e206961 100644 Binary files a/images/button-view@2x.png and b/images/button-view@2x.png differ diff --git a/index.html b/index.html index 86d233b8db..2301b021e4 100644 --- a/index.html +++ b/index.html @@ -6,6 +6,6 @@