...

• Always create a branch referring to sub-task from master branch

• We work in a trunk-based like:

  • Master branch ← sub-task branch

    • We should avoid to create Story branch. Only as last resource and if makes sense

• Branch name using the Jira ID and sub-task name:

  • examples:

    • To features: feat/IBFEC-123-sub-task-name

    • To bugs: fix/IBFEC-123-sub-task-name

    • To bugs in prod or fires: hotfix/IBFEC-123-sub-task-name

• Commit name:

  • Prefix - is the type of your commit. Accepted prefixes are:

    • feat | fix | hotfix | build | docs | ci | perf | refactor | style | test

    • examples:

      • [IBFEC-123] feat: added feature flag on component

      • [IBFEC-123] hotfix: fix to resolve save error

      • [IBFEC-123] test: create unit test component

  • This is based in Conventional Commits:

    • https://dev.to/maxpou/enhance-your-git-log-with-conventional-commits-3ea4

    • https://www.conventionalcommits.org/en/v1.0.0/

Good practices

...

when open a new PR

• If you are changing an existent code, after you finish is good to run the integration tests to validate that nothing was broken and attach the print on your pull request

• Always attach evidence of your job, unless it’s not possible

  • We suggest using the Before and After sections to compare what’s changed. If the repo doesn't have these sections, you should add them manually in the PR description

• Add descriptions that you think are worth mentioning, for example, when you adjust something that is not directly related to your task

...