Development setup and process flow

Environment setup

1. Clone the repository

2. Install IDE of your choice

   Note that project is configured for use with IntelliJ IDEA and this IDE is used as an example in the rest of this page.

3. Import project

   1. Select "Maven" project type
   2. In the next window, check following boxes:
      • Search for projects recursively
      • Import Maven projects automatically
      • Create module groups for multi-module Maven projects
   3. Make sure modules to be imported are checked
   4. Select "1.8" SDK version
   5. Wait for project and modules to be imported by IDE - it may take a while

4. Setup formatter

   1. Formatter settings file: resources/style_format/eclipse_format_code_standards.xml - file is in Eclipse format

      For IntelliJ, "Eclipse Code Formatter" plugin must be used

   2. Choose "Allure_Test_Framework_Format" as formatter profile

   3. Optionally, formatting can be set to be performed automatically on file save ("Save Actions" option in Eclipse, in IntelliJ there is a plugin named "Save Actions")

Development process flow

1. Create/assign to issue on board
2. Create branch in repository using "branch: " button
   • branch name should start with feature/ or bugfix/ prefix - please do not create branches without a prefix
   • branch name should contain issue number for easier tracking and some short description (e.g. feature/issue-123-my-feature)
   • branch should be created based on develop branch
3. Checkout branch on your local machine
   • using git tool:
     • git fetch and then git checkout <branch_name> OR
     • git pull and then git checkout <branch_name>

   • using IntelliJ: