Skip to content

Latest commit

 

History

History
60 lines (43 loc) · 1.99 KB

CONTRIBUTING.md

File metadata and controls

60 lines (43 loc) · 1.99 KB

CONTRIBUTING

What is the workflow?

  1. Create and describe your proposal/bug in an issue.
  2. Create a new branch and merge request with the pattern 1-my-feature.
  3. Commit your code to the commit convention.
  4. Finaly, update the CHANGELOG with:
poetry run log

Convention of Commits and Semantic Version

Commit Structure

type(escope): short description

What does the modification do?
why was it modified?

#issue

Types

  • fixed fixes a bug
  • added adds a new feature
  • removed remove a peace of code
  • merged solve a problem and merge in main
  • refactored does not add a feature or fix a bug
  • deprecated compatibility break

Semantic Version

  • merged -> Major
  • added -> Minor
  • fixed -> Patch

References