From 3ab6fde91349b7d234a38d483262303bcd2f6df1 Mon Sep 17 00:00:00 2001 From: mk Date: Thu, 18 Jul 2024 16:00:08 +0200 Subject: [PATCH] fix(docu):[#1070] switch tracefoss to GitHub issues --- CONTRIBUTING.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ae2dc59577..fb0201592a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -91,7 +91,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -* Add release notes for new version in [CHANGELOG.md](CHANGELOG.md) +* Add release notes for new version in [CHANGELOG.md](CHANGELOG.md) * Features of your product(s) or component(s), available for market entry * Please provide minimum 5 to maximum 10 key feature descriptions * Use category “ADDED” as per good practice @@ -103,7 +103,7 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). _**For better traceability add the corresponding GitHub issue number in each changelog entry, please.**_ ### git-hooks -Use git-hooks to ensure commit message consistency. +Use git-hooks to ensure commit message consistency. Detailed pattern can be found here: [commit-msg](https://github.com/eclipse-tractusx/traceability-foss/blob/457cb3523e981ef6aed98355a7faf0ff29867c33/dev/commit-msg#L4) #### How to use @@ -122,11 +122,10 @@ The commit messages have to match a pattern in the form of: ```` ```` -fix(api):[TRACEFOSS-123] Fix summary what is fixed. -chore(repos):[TRACEFOSS-123] Configuration change of ci cd pipeline for new repository. -docs(arc42):[TRACEFOSS-123] Added level 1 description for runtime view. - -chore(helm): TRACEFOSS-1131- Moving the values under the global key - increasing the version +fix(api):[#123] Fix summary what is fixed. +chore(repos):[#123] Configuration change of ci cd pipeline for new repository. +docs(arc42):[#123] Added level 1 description for runtime view. +chore(helm):[#113] Moving the values under the global key - increasing the version ```` ## Pull Request &  Reviews @@ -161,7 +160,7 @@ Only after the code is stable it can be merged to main. - chore/* - any small change without any impact - Branch Name: - MUST contain : Issue ID in the format #XXX - - MUST contain: Subject of issue (Abbreviation of pbi summary without using spaces / use "-" to connect) + - MUST contain: Subject of issue (Abbreviation of pbi summary without using spaces / use "-" to connect)