Skip to main content

Pull Request Decoration

As frontend developers, we try to make our work proccess as clear as possible. And for this purpose we use specific pull request decoration. Here below will be common pull request cases with examples.

Basic terms​

  • When create pull request check on 'squash commit' option
  • Create branch with ticket type prefixes (e.g. task/ for task tickets; bugfix/ for bug tickets)
  • Create branch with proper project key (e.g. task/PROJECT_NAME)
  • Create branch according to Jira ticket number (e.g. task/PROJECT_NAME-1337)
  • Branch name should be semantic (e.g. task/PROJECT_NAME-1337-add-new-user-menu)
  • Words in branch name should be chained with -

Update lib in dependencies​

Sometime we need to update version of our package in dependencies of another project (e.g. update ui-kit version in white label project and connected projects). To do so, start brach in project with specific naming referencing to original task number in Jira. Our Gitlab platform and Jira are connected, so it will create direct link to the Jira task in heading of your pull request. No additional description in pull request needed.

New feature implemented​

If new feature contains new UI element (e.g. button, widget) we create branch as usual plus we add additional description in pull request with images. If new feature affects only buisness logic, only description needed.

New design/redesign​

New design pull request should contains images of new and old elements to compare. Additional info should be also.

Bugfix/update code/eliminate tech debt​

Only description needed.

Additional​

In case you need to add image to description, you could also upload video/gif.