From bcd8577370206c7a1de7619b47f57b6a9d8a43b7 Mon Sep 17 00:00:00 2001 From: Daniil Polyakov Date: Fri, 22 May 2026 18:19:27 +0300 Subject: [PATCH] docs(contributing): add requirement to fill PR template before marking it as ready for review --- CONTRIBUTING.md | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f948d321..41bb535d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,7 +6,7 @@ This document describes the guidelines for contributing to the project. We will If you have any questions, come say hi to our [Discord](https://discord.gg/tGJwgGrSPN)! -## Commit and PR title format +## Commit title format We use [Conventional Commits](https://www.conventionalcommits.org/). @@ -33,11 +33,22 @@ Examples: Breaking changes: - Mark with `!` in the title. -- Optionally add a `BREAKING CHANGE:` footer in the PR body with migration notes. `CHANGELOG.md` is generated from these markers on every `v*` tag via `git-cliff`, and GitHub Releases are created from the same content. -Before merging PR consider squashing non-meaningful commits. E.g.: +## Pull requests + +PR titles should follow the same Conventional Commits format: +- `type(scope): description` +- `type(scope)!: description` for breaking changes + +Before marking a PR as ready for review: +- Fill out the PR template. + +Breaking changes in PRs: +- Optionally add a `BREAKING CHANGE:` footer in the PR body with migration notes. + +Before merging a PR, consider squashing non-meaningful commits. E.g.: ``` - refactor(wallet): move user keys to a separate module