This is an automated email from the ASF dual-hosted git repository.
pierrejeambrun pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new aa9f6a0d0d2 Add conventional commit (#68631)
aa9f6a0d0d2 is described below
commit aa9f6a0d0d2b387558b7c5c061e15fae983a40ec
Author: Jarek Potiuk <[email protected]>
AuthorDate: Tue Jun 16 10:28:26 2026 -0400
Add conventional commit (#68631)
---
contributing-docs/05_pull_requests.rst | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)
diff --git a/contributing-docs/05_pull_requests.rst
b/contributing-docs/05_pull_requests.rst
index 59a8fd8bae6..624b7ca5299 100644
--- a/contributing-docs/05_pull_requests.rst
+++ b/contributing-docs/05_pull_requests.rst
@@ -171,18 +171,24 @@ tooling, with a comment explaining what needs to be fixed.
Generic titles such as "Fix bug", "Update code", "Changes", single-word
titles, or titles
that only reference an issue number (e.g. "Fixes #12345") do not meet this
bar.
-2. **Meaningful description** — The PR body must contain a meaningful
description of *what* the
+2. ** Golden Rule ** - in text descriptions - always use imperative mode,
never use past
+ tense or conventional commits or any prefixes in the title take precious
space and do not add any value, so they should be
+ avoided. For example, instead of "feat: add new feature" or "Added this new
feature"
+ use "Add new feature". This is a common convention in many open source
projects
+ and it makes the commit history more readable and consistent.
+
+3. **Meaningful description** — The PR body must contain a meaningful
description of *what* the
PR does and *why*. An empty body, a body consisting only of the PR template
checkboxes/headers with no added text, or a body that merely repeats the
title is not
sufficient.
-3. **Passing static checks** — The PR's static checks (pre-commit / ruff /
mypy) must pass.
+4. **Passing static checks** — The PR's static checks (pre-commit / ruff /
mypy) must pass.
You can run them locally with ``prek run --from-ref main`` before pushing.
-4. **Gen-AI disclosure** — If the PR was created with the assistance of
generative AI tools,
+5. **Gen-AI disclosure** — If the PR was created with the assistance of
generative AI tools,
the description must include a disclosure (see `Gen-AI Assisted
contributions`_ below).
-5. **Coherent changes** — The PR should contain related changes only.
Completely unrelated
+6. **Coherent changes** — The PR should contain related changes only.
Completely unrelated
changes bundled together will be flagged.
**What happens when a PR is converted to draft?**
