From 2c35257eec68e5cdbef6e7f20f7bb9dea6b33465 Mon Sep 17 00:00:00 2001 From: Laurence Isla Date: Fri, 3 Nov 2023 16:10:03 -0500 Subject: [PATCH] chore: add prefix info to the PR template --- .github/PULL_REQUEST_TEMPLATE.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 0d782474f9..f62d5ec24d 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -3,4 +3,16 @@ When submitting a new feature or fix: - Add a new entry to the CHANGELOG - https://github.com/PostgREST/postgrest/blob/main/CHANGELOG.md#unreleased - If relevant, update the docs - https://github.com/PostgREST/postgrest-docs +- Use a prefix for the PR title or commits, e.g. "fix: description of the fix". + + `fix`, bug fixes + + `feat`, new features added + + `perf`, performance improvements + + `nix`, related to the Nix development environment + + `ci`, related to the Continuous Integration modules + + `test`, related to the testing modules + + `refactor`, refactoring code + + `deprecate`, deprecating a feature + + `chore`, maintenance (changelog, build process, etc.) + + Other prefixes may be used if necessary +- If there's a breaking change, add `BREAKING CHANGE` and an explanation to your commit message -->