CONTRIBUTING.md

Code Style

Catberry uses ESLint for checking the code style. You should run it using make lint before committing to the repo. If you need to fix indentations automatically then use make lint-fix.

make lint is a part of npm test script.

Tests

Catberry uses mocha and some rules:

• The test directory structure copies the actual structure of the project
• The test's describe calls should contain a class name and a method name like following:

describe('lib/finders/InjectionFinder', function () {
	describe('#find', function () {
		it('should find all dependency injections in source', function (done) {
			// test
		});
	});
});

You should run tests using make test before committing to the repo.

make test is a part of npm test script.

Docs

Write clean and simple docs in the docs/index.md file (if exists) or describe the feature in README.md if the package doesn't have separate documentation.

Submit a PR

• PR should be submitted from a separate branch (use git checkout -b "fix-123") to a master 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.