From 0bd145f0b88398d6c8199e0f9c20b15eeaff2c9b Mon Sep 17 00:00:00 2001 From: Volodymyr Shyrmanov Date: Sun, 14 Jul 2024 08:40:16 +0200 Subject: [PATCH] docs: upgrade contributing.md guide (#1133) * docs: upgraded CONTRIBUTING.md instructions --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2dc3bc1f9..e1a7488f6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,3 +12,20 @@ The base version represents the MAJOR and MINOR parts of [SemVer](https://semver - `main` contains the latest sources. Each merge there triggers a deploy to `nuget.org`. - All versions on `nuget.org` have a matching GitHub release/tag. + +## Commits and PR title + +- Please use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) to name your commits and PR title. + We use [action-semantic-pull-request](https://github.com/amannn/action-semantic-pull-request?tab=readme-ov-file#configuration) to enforce this policy, feel free to have a closer look. +- Available prefixes: + - `feat:` A new feature + - `fix:` A bug fix + - `docs:` Documentation only changes + - `style:` Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) + - `refactor:` A code change that neither fixes a bug nor adds a feature + - `perf:` A code change that improves performance + - `test:` Adding missing tests or correcting existing tests + - `build:` Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) + - `ci:` Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) + - `chore:` Other changes that don't modify src or test files + - `revert:` Reverts a previous commit