Branch naming

Create a branch by following the naming convention: <type>/<taskid>-<description-of-branch>.

<type> is:

  • feat - for new code (features, functionalities, etc.)
  • fix - for code updates (issue fixing, improvements)
  • delete - for deletion, removal, undoing of code
  • docs - for documentation
  • test - for code testing. NEVER merged these branches to master.

<taskid> is the ID of the work-item created previously.

<description-of-branch> describes what is accomplished on the branch. Use maximum 3 words, all lowercase, words separated by hyphens.

Examples

  • docs/1-remove-repository
  • feat/5-add-motd-task
  • fix/42-rename-workload-subscription

Conventional commit messages

Use conventional commit message when commiting changes to a branch: <type>: <description>

<type> is:

  • feat - for new code developments
  • fix - for fixes and improvements
  • delete - for permanent deletion of code
  • docs - documentation only changes
  • style - update formatting (white-spaces, indentation, etc.)

Examples

  • feat: add task to define motd on the node
  • fix: change published port used by container from 22 to 4444
  • docs: update section getting-started with contribute details in project readme
  • style: delete all trailing spaces in terraform files

Pull request

Choose two branches to see what’s changed or to start a new pull request

  • source: <name-of-your-branch>
  • into: master (always)

Use a descriptive title to explain what the PR addresses.

Examples

  • add doc about azure naming conventions to wiki
  • deploy storage account for tfstate on production subscription
  • refactor code for ansible role bootstrapping a linux virtual machine

The PR description contains a human-readable description of what changes are addressed with the PR. It aims at assisting the reviewers that are reading the PR. Each lines are less than 100 characters. All lower case. Indicate the related task (with prefix fixed or related), and the related user-story (with prefix related).

Examples

  • fixed: #1
  • related: #3

add description of naming conventions used for every resource deployed on azure with infrastructure-as-code