Development
One page summary of how to works on Backend project.
Branching
Branching
-
The base branch for all Backend work should be
develop
. -
When creating a branch for a new feature, use the format
features/{ticket-id}-feature-name
.
Example:features/AMP-123-contact-block
-
For bug fixes, follow the pattern
bugfixes/{ticket-id}-issue-name
.
Example:bugfixes/AMP-456-contact-block-header-issue
Apart from features/*
and bugfixes/*
, there are also infra/*
and refactor/*
branches.
Notes:
-
Always use the task/bug's ID as the ticket ID; do not use the user story's ID since it is shared between the Frontend and Backend teams.
-
All branches MUST include the ticket ID and a short description to help repository maintainers understand their purpose without needing to refer to the Jira ticket ID. This practice makes branch management more efficient.
-
Delete your branch after it has been merged into the base branch, unless there is a compelling reason to keep it.
Deployment
Whenever changes are pushed or merged into the inte
branch, it will initiate the deployment process to release the code into the INTE environment.
Whenever changes are pushed or merged into the prep
branch, it will initiate the deployment process to release the code into the PREP environment.
Whenever changes are pushed or merged into the prod
branch (or master
/main
, depending on your project's configuration), it will initiate the deployment process to release the code into the PROD environment.
While it's possible to deploy to the PREP and PROD environments by transferring the deployment package from lower environments through the PaaS Portal, it's advisable to prefer deployment via pipelines for consistency and reliability.