Skip to content

Latest commit

 

History

History
73 lines (50 loc) · 2.61 KB

CONTRIBUTING.md

File metadata and controls

73 lines (50 loc) · 2.61 KB

CONTRIBUTING

WORKFLOW

  1. Create and describe your proposal/bug in an issue.
  2. Create a new branch and pull request with the pattern 1-my-feature.

Gitlab Flow


DEVELOPMENT ENVIRONMENT

pre-req

  1. Update the image with Dockerfile
  2. Development and test inside a container before do git push

envdev


CONVENTIONAL COMMIT

type(escope): short description

What does the modification do?
why was it modified?

type

  • deprecated! compatibility break
  • add adds a new feature
  • fix fixes a bug
  • remove remove a peace of code
  • update does not add a feature or fix a bug

SEMANTIC VERSION

Major.Minor.Patch (e.g. 1.3.4)

  • deprecated! -> Major
  • add -> Minor
  • update | fix -> Patch

READTHEDOCS