Skip to content

Latest commit

 

History

History
52 lines (30 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

52 lines (30 loc) · 2 KB
Raw

Issues

Pull requests

  • Create a new topic branch for every separate change you make.
  • Create a test case if you are fixing a bug or implementing an important feature.
  • Make sure the build runs successfully (see below).

Development

Tools

We use the following tools for development:

  • Maven for Java Build.
  • NodeJS used for NPM (installed by Maven automatically).
  • NPM used to install Bower (installed by Maven automatically).
  • Bower used to get js-cookie for Integration tests (installed by NPM automatically).

Getting started

Install Maven and add mvn as a global alias to run the /bin/mvn command inside Maven folder.

Browse to the project root directory and run the build:

$ mvn install

After the build completes, you should see the following message in the console:

----------------------------------------------------------------------------
BUILD SUCCESS
----------------------------------------------------------------------------

Unit tests

To run the unit tests, execute the following command:

$ mvn test

Integration tests

If you want to debug the integration tests in the browser, switch Debug.FALSE to Debug.TRUE in CookiesEncodingIT.java and run the build:

$ mvn verify

Arquillian will start the server, Selenium will run the tests in Firefox, but the build will hang to allow debugging in the browser.

It uses the integration hook provided by the project js-cookie.