Collect reason why a change is made

[techcobweb]

Story

As a galasa developer I want to understand the 'why' a change was made, so when I look at code I can see what the trade-offs were and why things were done one way and not the other.

Background

This could be provided:

• On the commit comments.
  • These commit messages are often not great. We should do more in that direction to have a long commit message.
• On the branch name which delivers the change. Name the branch with the issue number inside. This is good practice anyway, because it makes things easier to clean up branches if we can see that the associated issue is closed or whatever. BUT this doesn't necessarily appear in blame or anything, and doesn't give people a 'clickable' link in the github UI
• On the PR text
  • PR text is sometimes blank, and doesn't explain the 'why' a change is made.
• On the issue
  • These are generally pretty good, but we often mis a clickable linkeage between the PR and the issue. The PR is always in a separate PR, as all our issues are in the ProjectManagement repo. (on of the troubles with more than one repo).

Suggestions

• Introduce a template for PRs, asking why this change is being made ? eg: Text on the why, or a link to the issue. Suggestion is in this PR: https://github.com/galasa-dev/cli/pull/229
  • Don't insist on a story/issue necessarily, as some small changes just need making and don't need much debate/time.
  • Roll that out to the other repositories also.
  • [ ] TSC
  • [ ] argocd-ibmcloud
  • [ ] automation
  • [ ] buildutils
  • [ ] cli
  • [ ] extensions
  • [ ] framework
  • [ ] galasa.dev
  • [ ] githubapp-copyright
  • [ ] gradle
  • [ ] helm
  • [ ] integratedtests
  • [ ] isolated
  • [ ] managers
  • [ ] maven
  • [ ] maven-new
  • [ ] obr
  • [ ] projectmanagement
  • [ ] simplatform
  • [ ] webui
  • [ ] wrapping

[techcobweb]

We will collect the why, but no template is needed.