CONTRIBUTING.md

Contributing to Popper.js

Report bugs

If you find a bug, please, try to isolate the specific case and provide a fiddle on CodePen or JSFiddle to make it easy to reproduce the problem and help others finding a solution. You can use this CodePen which already includes Popper.js.

If your issue is not about a bug, please make sure to consider posting on StackOverflow instead.

Feature requests are welcome!

Setup

Make sure to have grunt-cli and bower installed globally.

Then run:

npm install
bower install

Developing

We develop following a test driven development approach.

Test

We have a grunt + karma + jasmine environment to unit test Popper.js Feel free to add tests to the /tests folder, any JavaScript file in that folder will be executed as test.

To run tests:

npm test

Note: we use Chrome even for the tests on Travis CI, despite this, the CSS offsets of the page elements seem to be different when the tests are ran on Travis CI or on your local machine. Due to this problem, right now we make assertions checking both the local and CI offsets.

Any suggestion to get rid of this problem is more than welcome tho.

Build

To create a new release of Popper.js, run:

grunt dist

The files will be automatically minified and copied in the build directory.

Note: never commit changes and builds together! Each build should have its own dedicated commit.