Skip to content

Latest commit

 

History

History
58 lines (46 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

58 lines (46 loc) · 2.74 KB
Raw

Development and contributing

Internal development process

Development is performed by 2-weeks sprints (We use kind of Scrum framework) We use Git flow for development. Only repository masters (currently: Francis Pouatcha and Dimitry Mishchuk) are allowed to accept merge request to develop branch and make releases.

Definition of Ready

The task is ready to be put into a sprint when all following conditions are met:

  • All dependencies are clear and the work to work with them are clarified
  • Use-case is defined in the task
  • Acceptance criteria are defined

Definition of Done

The Task could be accepted only when following requirements are met:

  • Code is reviewed (and approved) by another developer
  • API documentation in Swagger UI corresponds to acceptance criteria
  • At least one automated test for every Use-case exists
  • Project documentation (Markdown files) contains the information how to run the demo of use case
  • Javadocs for public methods are written (including parameter description). For REST interfaces Swagger-annotations are sufficient.

Contributing

Any person are free to join us by implementing some parts of code or fixing some bugs and making a merge requests for them. The conditions listed in the Definition of Done are required to be fulfilled in any case.

Technical conditions for the implementations

Code styling

If you are using Intellij IDEs, like we do, please consider importing our code-style settings. General settings are also documented in .editorconfig file. You may find more information and a plugin for your editor/IDE here)

Java

  • Please use Optionals and corresponding streams instead of null-checks where possible
  • We prefer using Mockito over EasyMock for unit-tests.
  • We prefer SpringBoot autoconfiguration over manual Configuration where possible

Versioning and Releasing

We use SemVer for versioning. For the versions available, see the tags on this repository.

Release is being done using the release scripts ( (C) by Boris Skert ) located under scripts/release-scripts. For detailed info see README for release-scripts.

Steps to make a release

Release is made from local copy! Ensure that you have enough rights to push to master and develop branches

$ git submodule update --init --remote
$ scripts/release-scripts/release.sh <release-version> <next-develop-version>

Example

$ scripts/release-scripts/release.sh 1.0 1.1