Contributing to angular-breadcrumb

I am very glad to see this project living with PR from contributors who trust in it. Here is some guidelines to keep the contributions useful and efficient.

Development hints

Installation

Test running

This module uses the classic AngularJS stack with:

Run the test with the grunt task grunt test. It runs the tests with different versions of AngularJS.

Test developing

Tests are build around modules with a specific $stateProvider configuration:

Theses modules are loaded by Karma and they are available in test specifications.

Specifications are generally related to the directive ncyBreadcrumb or the service $breadcrumb.

Sample

If you are not familiar with JS testing. You can run the sample locally for testing purposes by using grunt sample. Sources are live-reloaded after each changes.

Submitting a Pull Request

Coding rules

Commit conventions

angular-breadcrumb uses the same strict conventions as AngularJS and UI-router. These conventions are explained here.

It is very important to fit these conventions especially for types fix and feature which are used by the CHANGELOG.md generation (it uses the grunt-conventional-changelog).