From e2054a7c433170ec699f65c2ff235ef176dd259e Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Mon, 1 Feb 2021 15:23:43 -0500 Subject: [PATCH 1/3] docs: first draft of conventional commits Mostly, this just establishes the guideline, points at the spec, and clarifies what we will and will not do. --- oeps/conventional-commits.rst | 77 +++++++++++++++++++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 oeps/conventional-commits.rst diff --git a/oeps/conventional-commits.rst b/oeps/conventional-commits.rst new file mode 100644 index 000000000..6c39f96ab --- /dev/null +++ b/oeps/conventional-commits.rst @@ -0,0 +1,77 @@ +#################### +Conventional Commits +#################### + +Abstract +******** + +Commits should be clearly labeled for their effect on consumers of the repository. To do this, we adopt the `Conventional Commits`_ guidelines, which detail structured commit messages that clarify the impact of each commit. + +This is part of our Change Transparency initiative. + +Spec +**** + +We are adopting the `Conventional Commits`_ spec, with our own adjustments. + +.. note:: Many people are familiar with the `Angular commit message format`_, which uses conventional commits and inspired the Conventional Commits spec. We are not adopting the Angular rules. + +Commit messages have these parts:: + + : + + + +