How to work with Issues and Pull Requests

Jump to bottom

Michael Bozhilov edited this page Oct 2, 2022 · 5 revisions

Issues

Issues are to be created when working on a feature, an optimization or a bug.
Issues are to be created if there is no previous issue for the task at hand.
Issues are to be given flags so that people can easily find a task which they want to work on (e.g. good first issue, devops)

Issues are automatically given an identification number, which is to be used when referencing commits:

git add . && git commit -m "#40 update something" # if issue we are working on is with id #40

Branches

Branches should reference the issue they are made for:

git checkout -b "#40-updating-something" # if issue we are working on is with id #40 (spaces are swapped for dashes)

Pull Requests

Pull Requests are to be opened towards the master branch. They should reference the issue they've been created for in the beginning of their title:

A short description to be added explaining the issue and the solution (preferably better than the one displayed in the image 😆 )