Skip to content

Files

Latest commit

 

History

History
42 lines (29 loc) · 1.52 KB

DEVELOPING.md

File metadata and controls

42 lines (29 loc) · 1.52 KB

Contributing to Bibernate project within Svydovets Team

Important links

Branching strategy

In this repository we maintain one key development branch dev. In most cases it should be updated via the Pull Request. The master branch will contain only stable releases.

Creating a Pull Request

Branching naming convention

A branch name...

  • should start from the word "feature" or "bugfix" (according to the type of ticket you are working on)
  • then following ticket name from Trello (e.g. "BN-34")
  • optionally there may follow short description

Example

  • feature/BN-5/baseStructure
  • bugfix/BN-23

Commits

  • In case you are working on the Trello ticket, please make sure that you always add its full number to every commit message
  • Please provide a descriptive messages
  • Use rebase

Definition of done

You are ready to create a PR for your ticket if the following criteria are met:

  • Local mvn verify is passing without the errors
  • Ticket`s acceptance criteria are met
  • Public methods should be covered by tests
  • Your code is covered by JavaDocs on the main methods