This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/datafusion.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 117468814f Publish built docs triggered by
d8e4e92daf7f20eef9af6919a8061192f7505043
117468814f is described below
commit 117468814f274db75710c2f1a96eb009da020cb6
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Wed Oct 16 22:16:01 2024 +0000
Publish built docs triggered by d8e4e92daf7f20eef9af6919a8061192f7505043
---
_sources/contributor-guide/index.md.txt | 14 ++++++++++++++
contributor-guide/index.html | 15 +++++++++++++++
searchindex.js | 2 +-
3 files changed, 30 insertions(+), 1 deletion(-)
diff --git a/_sources/contributor-guide/index.md.txt
b/_sources/contributor-guide/index.md.txt
index 79a9298798..4645fe5c88 100644
--- a/_sources/contributor-guide/index.md.txt
+++ b/_sources/contributor-guide/index.md.txt
@@ -116,6 +116,20 @@ If you are concerned that a larger design will be lost in
a string of small PRs,
Note all commits in a PR are squashed when merged to the `main` branch so
there is one commit per PR after merge.
+## Conventional Commits & Labeling PRs
+
+We generate change logs for each release using an automated process that will
categorize PRs based on the title
+and/or the GitHub labels attached to the PR.
+
+We follow the [Conventional Commits] specification to categorize PRs based on
the title. This most often simply means
+looking for titles starting with prefixes such as `fix:`, `feat:`, `docs:`, or
`chore:`. We do not enforce this
+convention but encourage its use if you want your PR to feature in the correct
section of the changelog.
+
+The change log generator will also look at GitHub labels such as `bug`,
`enhancement`, or `api change`, and labels
+do take priority over the conventional commit approach, allowing maintainers
to re-categorize PRs after they have been merged.
+
+[conventional commits]: https://www.conventionalcommits.org/en/v1.0.0/
+
# Reviewing Pull Requests
Some helpful links:
diff --git a/contributor-guide/index.html b/contributor-guide/index.html
index 68d2a35fbf..497a741005 100644
--- a/contributor-guide/index.html
+++ b/contributor-guide/index.html
@@ -547,6 +547,11 @@
Creating Pull Requests
</a>
</li>
+ <li class="toc-h2 nav-item toc-entry">
+ <a class="reference internal nav-link"
href="#conventional-commits-labeling-prs">
+ Conventional Commits & Labeling PRs
+ </a>
+ </li>
</ul>
</li>
<li class="toc-h1 nav-item toc-entry">
@@ -701,6 +706,16 @@ committer who approved your PR to help remind them to
merge it.</p>
<p>If you are concerned that a larger design will be lost in a string of small
PRs, creating a large draft PR that shows how they all work together can
help.</p>
<p>Note all commits in a PR are squashed when merged to the <code
class="docutils literal notranslate"><span class="pre">main</span></code>
branch so there is one commit per PR after merge.</p>
</section>
+<section id="conventional-commits-labeling-prs">
+<h2>Conventional Commits & Labeling PRs<a class="headerlink"
href="#conventional-commits-labeling-prs" title="Link to this
heading">¶</a></h2>
+<p>We generate change logs for each release using an automated process that
will categorize PRs based on the title
+and/or the GitHub labels attached to the PR.</p>
+<p>We follow the <a class="reference external"
href="https://www.conventionalcommits.org/en/v1.0.0/";>Conventional Commits</a>
specification to categorize PRs based on the title. This most often simply means
+looking for titles starting with prefixes such as <code class="docutils
literal notranslate"><span class="pre">fix:</span></code>, <code
class="docutils literal notranslate"><span class="pre">feat:</span></code>,
<code class="docutils literal notranslate"><span
class="pre">docs:</span></code>, or <code class="docutils literal
notranslate"><span class="pre">chore:</span></code>. We do not enforce this
+convention but encourage its use if you want your PR to feature in the correct
section of the changelog.</p>
+<p>The change log generator will also look at GitHub labels such as <code
class="docutils literal notranslate"><span class="pre">bug</span></code>, <code
class="docutils literal notranslate"><span
class="pre">enhancement</span></code>, or <code class="docutils literal
notranslate"><span class="pre">api</span> <span
class="pre">change</span></code>, and labels
+do take priority over the conventional commit approach, allowing maintainers
to re-categorize PRs after they have been merged.</p>
+</section>
</section>
<section id="reviewing-pull-requests">
<h1>Reviewing Pull Requests<a class="headerlink"
href="#reviewing-pull-requests" title="Link to this heading">¶</a></h1>
diff --git a/searchindex.js b/searchindex.js
index f84abfd231..dbe26f99ee 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"!=": [[47, "op-neq"]], "!~": [[47,
"op-re-not-match"]], "!~*": [[47, "op-re-not-match-i"]], "!~~": [[47, "id18"]],
"!~~*": [[47, "id19"]], "#": [[47, "op-bit-xor"]], "%": [[47, "op-modulo"]],
"&": [[47, "op-bit-and"]], "(relation, name) tuples in logical fields and
logical columns are unique": [[9,
"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]], "*":
[[47, "op-multiply"]], "+": [[47, "op-plus"]], "-": [[47, "op-minus"]], "/":
[[4 [...]
\ No newline at end of file
+Search.setIndex({"alltitles": {"!=": [[47, "op-neq"]], "!~": [[47,
"op-re-not-match"]], "!~*": [[47, "op-re-not-match-i"]], "!~~": [[47, "id18"]],
"!~~*": [[47, "id19"]], "#": [[47, "op-bit-xor"]], "%": [[47, "op-modulo"]],
"&": [[47, "op-bit-and"]], "(relation, name) tuples in logical fields and
logical columns are unique": [[9,
"relation-name-tuples-in-logical-fields-and-logical-columns-are-unique"]], "*":
[[47, "op-multiply"]], "+": [[47, "op-plus"]], "-": [[47, "op-minus"]], "/":
[[4 [...]
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
