From 12b592ffa14229efa463b3ffa98a10384b726bae Mon Sep 17 00:00:00 2001 From: Adam Kudrna Date: Thu, 17 Aug 2023 15:37:57 +0200 Subject: [PATCH] Docs: Introduce component documentation guidelines --- CONTRIBUTING.md | 80 ++++++++++++++++++++++++++++++------------------- 1 file changed, 49 insertions(+), 31 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0a1e2bfa96..97fc5b94c8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,6 +7,7 @@ Here are some tips how to make your contributing efforts efficient and eventuall - [Project structure](#project-structure) - [Commit Conventions](#commit-conventions) - [Code style](#code-style) +- [Documenting the Components](#documenting-the-components) - [Publishing](#publishing) ## General usage @@ -19,11 +20,11 @@ This project is a monorepo managed by [Lerna][lerna-home]. This means that each ## Commit Conventions -All commits you make should adhere to our commit guidelines. We use [conventional commits][conventional-commits] strategy with slight modification of our own - [@lmc-eu/commitlint-config][commitlint-config]. This is later used during release phase to determine how to bump the packages' version numbers based on commit history. 🚀 +All commits you make SHOULD adhere to our commit guidelines. We use [conventional commits][conventional-commits] strategy with slight modification of our own - [@lmc-eu/commitlint-config][commitlint-config]. This is later used during release phase to determine how to bump the packages' version numbers based on commit history. 🚀 ### Commit Message Format -We have very precise rules over how our Git commit messages must be formatted. +We have very precise rules over how our Git commit messages MUST be formatted. This format leads to **easier to read commit history**. Each commit message consists of a **header**, a **body**, and a **footer**. @@ -36,12 +37,12 @@ Each commit message consists of a **header**, a **body**, and a **footer**.