Skip to content

Latest commit

 

History

History
47 lines (37 loc) · 2.47 KB

CONTRIBUTING.md

File metadata and controls

47 lines (37 loc) · 2.47 KB
Raw

Contributing

  1. Open a new issue or pick up an existing one
  2. Code, unit tests, document, etc.
  3. Commit your changes with message "Fix #X Issue title"
  4. Create a PR
  5. Check that the builds are green
  6. Fix any SonarQube issues that would have pop up during the builds
  7. Assign racodond (David RACODON) as reviewers of the PR
  8. Once approved, merge the PR (prefer Squash and merge)

Building and Testing

  • To retrieve dependencies: npm install --no-optional
  • To run unit tests: npm run test
  • To run end-to-end tests: npm run e2e-test.
    • If you are behind a proxy, uncomment (and update if necessary) line seleniumInstallArgs: { // proxy: 'http://localhost:3128' in test/e2e/conf/realm/part/chrome.js and test/e2e/conf/realm/part/firefox.js.
    • Depending on the versions of Chrome and Firefox installed on your computer, you might need to update chromedriver version in test/e2e/conf/realm/part/chrome.js and gheckodriver version in test/e2e/conf/realm/part/firefox.js.
  • To run end-to-end tests in Docker containers: npm run e2e-test-docker.
    • If you are behind a proxy, run npm run e2e-test-docker -- --proxyPort=XXXX instead.

Publishing a new version of the npm package

Requirements:

  1. Check that the latest build on master is green
  2. Check that the SonarQube quality gate is green

From your IDE:

  1. Checkout a clean master branch
  2. Update the package version by running the following command replacing <type> with either major, minor or patch:
npm version <type> -m "Release version %s"

It upgrades the version in package.json and commit the change with "Release version X.X.X" message.

  1. Generate the JSDoc by running npm run doc
  2. Push the changes in ./docs to GitHub: git add docs && git commit -m "Generate documentation for version 2.5.0" && git push origin master
  3. Publish a new release of the npm package by running npm publish

From your browser:

  1. Close the milestone
  2. Publish a new new release on GitHub: