Project template - Improvements

Problem

The project template can be improved after its initial approval. This ticket collects a few immediate items we could add to it.

This is a follow-up to #209 (closed) after Sprint 4.

Goal

Further improve the project template repository.

ACs

Improvements

  • Explain in How to use it how to add it to an existing project
  • Mention in the Development Workflow that signed / verified commits are preferred
  • Update the branch naming guidelines so they match the Team Agreement
  • Mention that Review Threads should all be resolved before merging MR's
  • Mention how rebasing during reviews should be avoided
  • Add CI Badges to the README.md (builds, tests pass, deps)
  • Add a checklist for setting up the repository config (protected branches, PATs, etc)
  • Upstream the solution-architecture cspell accepted words (regularly?)
  • Add shellcheck quality gate to both git hooks and CI
  • Mention how to add RENOVATE_GITHUB_COM_TOKEN to get Github Release notes in the MRs
  • Remove the [skip ci] commit msg default so that CI runs when merging from main back to develop
  • Automate merging main back into develop after a release

Notes/ resources

Who needs to be involved / informed

  • involved: ?
  • informed: ?
Edited by Milton Moura (Nordeck)