This is an automated email from the ASF dual-hosted git repository.
dstandish 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 a9c350762d Clarify "significant" newsfragment vs significant
newsfragment _type_ (#24450)
a9c350762d is described below
commit a9c350762db4dca7ab5f6c0bfa0c4537d697b54c
Author: Daniel Standish <[email protected]>
AuthorDate: Tue Jun 14 13:08:52 2022 -0700
Clarify "significant" newsfragment vs significant newsfragment _type_
(#24450)
Previously was tiny bit ambiguous and could make it appear that any
newsfragment type could have summary + body. Also I remove the word "simply"
just because it's a pet peeve of mine.
---
CONTRIBUTING.rst | 6 ++----
1 file changed, 2 insertions(+), 4 deletions(-)
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 19df2a5f70..a906c0eec2 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -341,13 +341,11 @@ Step 4: Prepare PR
* `doc`
* `misc`
- To add a newsfragment, simply create an rst file named
``{pr_number}.{type}.rst`` (e.g. ``1234.bugfix.rst``)
+ To add a newsfragment, create an ``rst`` file named
``{pr_number}.{type}.rst`` (e.g. ``1234.bugfix.rst``)
and place in either `newsfragments
<https://github.com/apache/airflow/blob/main/newsfragments>`__ for core
newsfragments,
or `chart/newsfragments
<https://github.com/apache/airflow/blob/main/chart/newsfragments>`__ for helm
chart newsfragments.
- For significant newsfragments, similar to git commits, the first line is
the summary and optionally a
- body can be added with an empty line separating it.
- For other newsfragment types, only use a single summary line.
+ In general newsfragments must be one line. For newsfragment type
``significant``, you may include summary and body separated by a blank line,
similar to ``git`` commit messages.
2. Rebase your fork, squash commits, and resolve all conflicts. See `How to
rebase PR <#how-to-rebase-pr>`_
if you need help with rebasing your change. Remember to rebase often if
your PR takes a lot of time to
