From 518bb7969a3e869a2db7d0dbfd3208b7dc6b9205 Mon Sep 17 00:00:00 2001 From: soyuka Date: Tue, 27 Apr 2021 22:16:38 +0200 Subject: [PATCH] docs: use conventional commits --- CONTRIBUTING.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 88533097f08..4ec00f91b66 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,6 +77,32 @@ When you send a PR, just make sure that: that you did not make in your PR, you're doing it wrong. * Also don't forget to add a comment when you update a PR with a ping to [the maintainers](https://github.com/orgs/api-platform/people), so he/she will get a notification. +The commit messages must follow the [Conventional Commits specification](https://www.conventionalcommits.org/). +The following types are allowed: + +* `fix`: bug fix +* `feat`: new feature +* `docs`: change in the documentation +* `spec`: spec change +* `test`: test-related change +* `perf`: performance optimization +* `ci`: CI-related change +* `chore`: updating dependencies and related changes + +Examples: + + fix(metadata): resource identifiers from properties + + feat(validation): introduce a number constraint + + feat(metadata)!: new resource metadata system, BC break + + docs(doctrine): search filter on uuids + + test(doctrine): mongodb disambiguation + +We strongly recommend the use of a scope on API Platform core. + ### Tests On `api-platform/core` there are two kinds of tests: unit (`phpunit` through `simple-phpunit`) and integration tests (`behat`).