From 56dc4aa7847cae10de1bf1b3d0f301a519882dab Mon Sep 17 00:00:00 2001
From: Ulf Gebhardt <ulf.gebhardt@webcraft-media.de>
Date: Tue, 26 Nov 2024 19:15:23 +0100
Subject: [PATCH] validate PR title guide in Pull request template

Adds a guide for the PR titles in the PR template. This will make it
easier for people to understand this, but comes with the downside that
you need to adjust this part for each project aswell.
---
 .github/PULL_REQUEST_TEMPLATE.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index d40a277..dc3613c 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,5 +1,18 @@
 <!-- You can find the latest issue templates here https://github.com/ulfgebhardt/issue-templates -->
 
+<!--
+Validate your PR title - a quick Guide
+
+A valid PR title contains a type (https://github.com/commitizen/conventional-commit-types/blob/master/index.json), a scope (https://github.com/ulfgebhardt/issue-templates/blob/master/.github/workflows/test.lint.pr.yml#L31) and a title starting with a lower case letter.
+
+Here are some valid examples:
+- fix(docu): my fix
+- feat(docker): my feature
+- docs(release): my docs
+- refactor(workflow) : my refactor
+- test(other): my test
+-->
+
 ## 🍰 Pullrequest
 <!-- Describe the Pullrequest. Use Screenshots if possible. -->