Skip to content

Latest commit

 

History

History
56 lines (32 loc) · 1.78 KB

CONTRIBUTE.md

File metadata and controls

56 lines (32 loc) · 1.78 KB

Contributing Guide for Artemis

Please read this guide before creating a pull request, otherwise your contribution might not be approved.

Branch Organization

All pull request branches are created from develop.

We use the following structure for branch names:

<type>/<area>/<short-description>

Possible types are:

  • feature
  • enhancement
  • bugfix
  • hotfix

The pull request template will provide additional information on the requirement for the integration of changes into Artemis.
Once the changes in your pull request are approved by one of our reviewers, they can be merged into develop.

Development Workflow

Find here a guide on how to setup your local development environment.

Testing

We create unit & integration tests for the Artemis server and client. Adding tests is an integral part of any pull request - please be aware that your pull request will not be approved until you provide automated tests for your implementation!

Server Testing

We use the Spring Boot testing utilities for server side testing.

Location of test files: src/test/java

Execution command: ./gradlew executeTests

Client Testing

We use Jest for client side testing.

For convenience purposes we have Sinon and Chai as dependencies, so that easy stubbing/mocking is possible (sinon-chai).

Location of test files: src/test/javascript

Execution command: yarn test

The folder structure is further divided into:

  • component
  • integration
  • service

The tests located in the folder /app are not working at them moment and are not included in the test runs.