potiuk commented on code in PR #44378:
URL: https://github.com/apache/airflow/pull/44378#discussion_r1859474394
##########
contributing-docs/16_contribution_workflow.rst:
##########
@@ -196,7 +196,9 @@ Step 4: Prepare PR
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.
- 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.
+ In general newsfragments must be one line. For newsfragment type
``significant``,
+ you should follow the template in
``newsfragments/template.significant.rst`` to include summary, body, change
type and migrations rules needed.
+ This can also be done by command ``uv tool run towncrier create --dir .
--config newsfragments/config.toml --content `cat
newsfragments/template.significant.rst```.
Review Comment:
Two fixes/suggestions in one:
* The `cat` without quotes does not work in `zsh` on linux at least - it
fails with "Error: Got unexpected extra arguments (a short and imperative
summary of this changes ... " as the content is passed as arguments
* The `+.significant.rst` will avoid asking questions about issue and type
and it will create a random-generated newsfragment prefix - which I think is a
good idea - we should likely stop using PR# as newsfragment id as this is
always chicken-egg problem - you can only add newsfragment after you create PR
- with random prefix we avoid that chicken/egg and there is little value I
think with having PR # in newsfragment (you can always git-blame to check the
PR # it was merged in).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
