From c5ea6cca5820cdb369c8b32d271cf9fe027129cf Mon Sep 17 00:00:00 2001 From: Oliver Booth Date: Wed, 12 Apr 2023 12:47:32 +0100 Subject: [PATCH] [ci skip] docs: add conventional commit to contrib guidelines --- CONTRIBUTING.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c1d7f77..5aae0b4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -9,6 +9,10 @@ This project uses C# 11.0 language features where feasible, and adheres to Style There is an `.editorconfig` included in this repository. For quick and painless pull requests, ensure that the analyzer does not throw warnings. +Please ensure that you follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) +specification, as the GitHub release for this project is automatically generated from the commit history, and formatted using the +convetional commits specification. + ### Code style Below are a few pointers to which you may refer, but keep in mind this is not an exhaustive list: