From 438e2c40ad2378d1f26e5e8f9ea6790b155def83 Mon Sep 17 00:00:00 2001 From: Manuel Hatzl Date: Sat, 19 Aug 2023 14:20:28 +0200 Subject: [PATCH] fix: update contributing section to new commit types --- CONTRIBUTING.md | 104 ++++++++++++++++++++++-------------------------- 1 file changed, 47 insertions(+), 57 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f976f3..370afdd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,23 +18,16 @@ It is a good place to start if you have any questions. There are two issue labels to help possible contributors to get involved. -- `good first issue` ... This label is used to mark issues that should be easy to implement **without** extensive understanding of the project -- `help-needed` ... This label is used to mark issues, where project members need help to resolve it - -## Commit Message Convention - -We have precise rules on how we write our git commit messages.\ -This leads to **more readable messages** that are easy to follow when looking through the **project history**. -But also, we use git commit messages to automatically get a **change log** using [release-please](https://github.com/googleapis/release-please) from Google. - -**Note:** We use `squash merging` for pull requests, so we are able to correct your commit messages, but please try to stick to the convention to make merging easier for us. +- [good-first-issue](https://github.com/mhatzl/project-repo-template/labels/good-first-issue) ... This label is used to mark issues that should be easy to implement **without** extensive understanding of the project +- [help-needed](https://github.com/mhatzl/project-repo-template/labels/help-needed) ... This label is used to mark issues, where project members need help to resolve it ## Wiki We use the [GitHub Wiki](https://github.com/mhatzl/project-repo-template/wiki) for developer related information. -For example, it contains project requirements, decision records, and views/models of the project. +For example, it contains project [requirements](https://github.com/mhatzl/project-repo-template/wiki/5-Requirements), +[decision records](https://github.com/mhatzl/project-repo-template/wiki/6-Decision-Records), and [system views/models](https://github.com/mhatzl/project-repo-template/wiki/4-System-Views) of the project. -**Note:** Issues for the wiki must be created in this repository, but PRs are handled in a separate [GitHub repository](https://github.com/mhatzl/wiki-repo-template). +**Note:** Issues for the wiki must be created in this repository, but PRs are handled in the [GitHub repository of the wiki](https://github.com/mhatzl/wiki-repo-template). ## Development Setup @@ -44,10 +37,19 @@ Provide instructions on how to set up this project for development. }} +## Commit Message Convention + +We have our own convention for git commit messages that are inspired by [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).\ +This leads to more **readable** messages that are easy to follow when looking through the [project's history](https://github.com/mhatzl/project-repo-template/commits/main). +In addition, we use git commit messages to automatically get a **change log** using [release-please](https://github.com/googleapis/release-please) from Google. +As a result, commit messages not following our convention won't appear in the generated change log. + +**Note:** We use `squash merging` for pull requests, so we are able to correct your commit messages, but please try to stick to the convention to make merging easier for us. + ### Commit Message Format Each commit message consists of a **header**, a **body**, and a **footer**.\ -The header has a special format that includes a **type** and a **subject**: +The header itself consists of a **type** and a **subject**: ~~~ : @@ -57,27 +59,8 @@ The header has a special format that includes a **type** and a **subject**: