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.
npm install
bower install
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.
Tests are build around modules with a specific $stateProvider
configuration:
ncyBreadcrumbLabel
ncyBreadcrumbLabel
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
.
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.
grunt
or grunt default
): it will run the tests and build the module in dist
directory)dist
directory) by using the commit conventions explained below.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).