CONTRIBUTING.md

Code Style

Catberry follows its own Code Style Guide which is actually similar with Airbnb style guide except several moments.

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

Tests

Catberry uses 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:

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 and ask them there.