...
The code reviews are per task;
Create a feature flag to your feature and create a technical debt to remove the flag posteriorly
Analyze cicle-ci: https://app.BRANCHScircleci.com/projects/project-dashboard/github/rbilabs/
Check if your PR is good at the pipeline workflow
After the merge to master, check if all is well and if the job runs till the end
Branchs and commits
Always create a branch referring to sub-task from
master
branchWe 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 OR feat/IBFEC-123
To bugs: fix/IBFEC-123-sub-task-name OR fix/IBFEC-123
To bugs in prod or fires: hotfix/IBFEC-123-sub-task-name OR hotfix/IBFEC-123
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 componentAnalyze each commit on cicle-ci:
This is based in Conventional Commits:
- appcircleci.comprojects/project-dashboard/github/rbilabs
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
...
PR name: Always use the sub-task name for the title and the sub-task Jira ID for the “label” [IBFEC-X]
[IBFEC-3][Q2] - Optional Secondary Call to Action
Summary: A summary of what this activity is about, for example:
In this demand, a new flow was developed to save the user's address.Context: Give the context with more details of the development
Add the Jira link of the story, Figma, Confluence and etc
It is important to inform which flags were added, another important detail is to verify the impact of this flag turned on, as a guarantee to leave it turned on only in DEV environments and for PLK.the needed environment (for example, PLK ES)
Adding extra context information, for example:
...