Pull Request Workflow

Introduction

This page describes how our workflow for Pull Requests works.

Workflow Overview

Create Branch

Before a pull request can be opened, please follow these steps:

  1. Create a branch on git
  2. Add your changes with git commit (use Conventional Commits)
  3. Push your changes to GitHub with git push

Create Pull Request

Your code is ready for production. To merge it you need to open a pull request. If you are not sure or you still want to work on it please open your pull request as draft.

Open Pull Request

  1. Add easy understandable description
  2. Assign reviewer(s)
  3. Create pull request or draft

Notification

Ensure to enable notifications for GitHub

Review open pull requests

Someone opened a pull request and assigned you for review.

  1. Please define yourself as reviewer first (so others see you are on it)
  2. Review pull request

IMPORTANT: With assigning as reviewer you take responsibility for this pull request. Try to solve issues as soon as possible. No other should be required to get involved.

Handle requested changes

When changes are requested you have two options:

  1. Accept suggestion by using Commit suggestion button
  2. Resolve issue after conversation by using Resolve conversation button

Changes requested example

Please resolve all issues first. Then request a pull request review again. Either by using the button on the upper right corner

Re-request review at top

or by using the function at the bottom of the pull request.

Re-request review at bottom

Avoid Discussions

Comments are for quick notes only! Avoid starting a discussion. Better schedule a meeting to discuss open issues. Afterwards close those comments with a small hint to the discussion results.