workflow - PGP1/plantly-wiki GitHub Wiki

Workflow

Branch name

Branch name will be associated with an issue number.

  • Example: 5_Setup-raspberry-pi

This is linked to issue number 5 with the branch name Setup Raspberry Pi

Demo:

Issues

Each issue will be linked to an User Story. Issue will have user story name in the front in the format US x.x in which x.x is the user story number refer to Trello

Each issue will be related to a branch. Any problems with a branch should be discussed within the Issues.

  • Example: [US 3.2] Cloud communication with local sensors

In the issue description you need to include:

  1. Link to the trello user sotry
  • Example: Trello: https://trello.com/c/25RFxcMD/5-us15-sensors
  1. Ref link (optional)
  • To refer to other issues

Demo:

Commit

Commit will need to have user story number. For example: [US 1.5] Refactor.

This will make it easier to see when making pull request.

Demo:

⚠️ **GitHub.com Fallback** ⚠️