Skip to content

Commit

Permalink
Merge branch 'release/1.1.6'
Browse files Browse the repository at this point in the history
  • Loading branch information
Denis Rechkunov committed Jun 14, 2015
2 parents d8a7844 + b281aef commit 26d9fa8
Show file tree
Hide file tree
Showing 5 changed files with 43 additions and 16 deletions.
2 changes: 0 additions & 2 deletions .coveralls.yml

This file was deleted.

31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## Code Style
Catberry follows its own [Code Style Guide](https://github.com/catberry/catberry/blob/develop/docs/code-style-guide.md)
which is actually similar with [Airbnb style guide](https://github.com/airbnb/javascript/tree/master/es5) except several moments.

Please do not forget to use `npm test` to be sure that your code is awesome.

## Tests
Catberry uses [mocha](https://www.npmjs.org/package/mocha) and some rules:

* The `test` directory structure copies the actual structure of the project
* The test's `describe` call should contain the Constructor
and prototype's method name:
```javascript
describe('lib/finders/InjectionFinder', function () {
describe('#find', function () {
it('should find all dependency injections in source', function (done) {
// test
});
});
});
```

## Docs
Write clean and simple docs in the `docs/index.md` file or describe the feature in `README.md` if the package doesn't have documentation.

## Submit a PR
* PR should be submitted from a separate branch (use `git checkout -b "fix-123"`) to a `develop` branch
* PR should not decrease the code coverage more than by 1%
* PR's commit message should use present tense and be capitalized properly (i.e., `Fix #123: Add tests for RequestRouter`)

Still have any questions? Join the [Gitter](https://gitter.im/catberry/catberry) and ask them there.
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ else
--bail
endif

coveralls: test-cov
cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js
send-cov: test-cov
cat ./coverage/lcov.info | ./node_modules/.bin/codecov

travis: coveralls
travis: send-cov
clean:
rm -rf coverage

Expand Down
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Service Locator for Catberry Framework [![Build Status](https://travis-ci.org/catberry/catberry-locator.png?branch=master)](https://travis-ci.org/catberry/catberry-locator) [![Coverage Status](https://coveralls.io/repos/catberry/catberry-locator/badge.png?branch=master)](https://coveralls.io/r/catberry/catberry-locator?branch=master)
# Service Locator for Catberry Framework [![Build Status](https://travis-ci.org/catberry/catberry-locator.png?branch=master)](https://travis-ci.org/catberry/catberry-locator) [![codecov.io](http://codecov.io/github/catberry/catberry-locator/coverage.svg?branch=master)](http://codecov.io/github/catberry/catberry-locator?branch=master)
[![NPM](https://nodei.co/npm/catberry-locator.png)](https://nodei.co/npm/catberry-locator/)

## Description
Expand Down Expand Up @@ -124,15 +124,13 @@ http

```
## Contribution
If you have found a bug, please create pull request with [mocha](https://www.npmjs.org/package/mocha)
unit-test which reproduces it or describe all details in an issue if you can not
implement test. If you want to propose some improvements just create an issue or
a pull request but please do not forget to use `npm test` to be sure that your
code is awesome.
## Contributing
All changes should satisfy this [Code Style Guide](https://github.com/catberry/catberry/blob/4.0.0/docs/code-style-guide.md).
There are a lot of ways to contribute:
Also your changes should be covered by unit tests using [mocha](https://www.npmjs.org/package/mocha).
* Give it a star
* Join the [Gitter](https://gitter.im/catberry/catberry) room and leave a feedback or help with answering users' questions
* [Submit a bug or a feature request](https://github.com/catberry/catberry-locator/issues)
* [Submit a PR](https://github.com/catberry/catberry-locator/blob/develop/CONTRIBUTING.md)
Denis Rechkunov <[email protected]>
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "catberry-locator",
"version": "1.1.5",
"version": "1.1.6",
"author": "Denis Rechkunov <[email protected]>",
"description": "Service Locator component for Catberry Framework",
"homepage": "https://github.com/catberry/catberry-locator",
Expand All @@ -24,7 +24,7 @@
"main": "./lib/ServiceLocator.js",
"devDependencies": {
"istanbul-harmony": "~0.3.1",
"coveralls": "^2.11.2",
"codecov.io": "^0.1.2",
"mocha": "^2.1.0",
"jscs": "~1.6.2",
"jshint": "^2.6.0"
Expand Down

0 comments on commit 26d9fa8

Please sign in to comment.