From 94ffe660febb3621c671b24cda17d5b8b86eebe6 Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Mon, 20 Jul 2026 10:19:56 +0000 Subject: [PATCH] docs: document semantic PR title guidance Signed-off-by: Gregor Zeitlinger --- CONTRIBUTING.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d2a93b676..519b98fea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,6 +12,18 @@ Prometheus uses GitHub to manage reviews of pull requests. This will avoid unnecessary work and surely give you and us a good deal of inspiration. +## Pull Request Titles + +Use a [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary)-style +title for pull requests: + +```text +[optional scope]: +``` + +For example: `fix(metrics): handle empty scrapes`. Common types include `feat`, `fix`, +`docs`, `test`, `refactor`, `perf`, `build`, `ci`, `chore`, and `revert`. + ## Signing Off Commits Every commit must include a `Signed-off-by` line, as required by the