Skip to content

Latest commit

 

History

History
39 lines (24 loc) · 957 Bytes

CONTRIBUTING.md

File metadata and controls

39 lines (24 loc) · 957 Bytes

Rules to work on the project:

Commits:

All commits must respect the convention of conventional commit.

A commit needs to have a title. The title must respect the pattern: 'type: summary' or 'type(scope): summary'.

All the following is taken from https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13

Rules:

If a type contains '!', the commit introduces a BREAKING CHANGE.
Example: feat!(automat): The hub takes a HubProcessing.

All available scopes :

Directories 'docs' and 'tests' are implicit when use the type 'docs' and 'test'.

api:

  • api/subscope
    • config
    • vX
    • utils

Example: refactor(api/config): Change signature of Configuration

domain:

  • domain/subscope
    • models
    • use_cases

Example: refactor(domain/models): Change the model CaesarInput