Home

Setup Code Style Guidelines

Code Style

• The following Code Style should be used in order to contribute to the project: Code style here
• Code should be well documented with Javadocs
• Code should be written according to best practices using new Java features

Branch naming conventions

{feature/bugfix}/{team_uppercase}-{issue number}

Example: feature/BLZT-2617

Commit naming conventions

[{team_uppercase}-{issue number}] {Commit message}

Example: [BLZT-2617] Application Context implementation

Pull request requirements

• Pull request (PR) should be created from branch that meets Branch naming conventions
• Commits in PR should meet Commit naming conventions
• PR title should be of the same format as Commit naming conventions and describe what was done under its scope
• PR description might be present or not, depending on the logic complexity
• Code written under scope of the PR should pass the following checks:
• • Successful build
• • Team Code Style
• • SonarQube Code Analysis:
• • • Tests code coverage > 80%
• • • 0 bugs
• PR can be merged with at least one approving review and all “requested changes” resolved

Merge strategy

• Merging directly to the main branch is not allowed. Merge should be performed via a PR.
• Merge strategy: Squash and Merge