Skip to content

Latest commit

 

History

History
49 lines (33 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

49 lines (33 loc) · 1.61 KB

Contributing guide

Local development

Environment

Required tools

Adding a new feature

  1. (optionally) create issue on github / gitlab with requested feature description and possible implementation, then discuss with maintainers

  2. create a new feature branch from latest master

    example:

    git fetch --all
    git pull origin master
    git checkout -b feature/my-new-shiny-feature
  3. make changes in codebase

  4. build changes and test it locally

    example:

    docker-compose build --pull
  5. commit changes, and push to your fork, then create Merge Request / Pull Request, please stick to conventional-changelog convention when making commits

  6. make sure tests passes on CI

  7. wait for maintainer to review and eventually merge your Merge Request / Pull Request

Upgrading dependencies

Source list of external dependencies