Copilot commented on code in PR #65629:
URL: https://github.com/apache/airflow/pull/65629#discussion_r3122597163
##########
dev/breeze/src/airflow_breeze/commands/sbom_commands.py:
##########
@@ -198,11 +198,15 @@ def sbom_group():
)
@click.option(
"--remote-name",
- type=NotVerifiedBetterChoice(["apache", "origin"]),
- default="apache",
+ type=NotVerifiedBetterChoice(["upstream", "origin"]),
+ default="upstream",
show_default=True,
Review Comment:
`NotVerifiedBetterChoice` is used for shell completion and help output;
removing `apache` from the choices means existing setups that still use an
`apache` remote won't see it suggested/shown in `--help` even though the value
is still accepted. Consider keeping `apache` in the choices list (while
defaulting to `upstream`) to preserve discoverability/back-compat during the
transition.
##########
contributing-docs/10_working_with_git.rst:
##########
@@ -139,30 +177,30 @@ First of all, we suggest you read about the rebase
workflow here:
`Merging vs. rebasing
<https://www.atlassian.com/git/tutorials/merging-vs-rebasing>`_. This is an
excellent article that describes all the ins/outs of the rebase workflow. I
recommend keeping it for future reference.
-The goal of rebasing your PR on top of ``apache/main`` is to "transplant" your
change on top of
+The goal of rebasing your PR on top of ``upstream/main`` is to "transplant"
your change on top of
the latest changes that are merged by others. It also allows you to fix all
the conflicts
-that arise as a result of other people changing the same files as you and
merging the changes to ``apache/main``.
+that arise as a result of other people changing the same files as you and
merging the changes to ``upstream/main``.
Here is how rebase looks in practice (you can find a summary below these
detailed steps):
1. You first need to add the Apache project remote to your git repository.
This is only necessary once,
-so if it's not the first time you are following this tutorial you can skip
this step. In this example,
-we will be adding the remote as "apache" so you can refer to it easily
+so if it's not the first time you are following this tutorial you can skip
this step. Per the
+`Git remote naming conventions`_ we add it as ``upstream``:
-* If you use ssh: ``git remote add apache [email protected]:apache/airflow.git``
-* If you use https: ``git remote add apache
https://github.com/apache/airflow.git``
+* If you use ssh: ``git remote add upstream
[email protected]:apache/airflow.git``
+* If you use https: ``git remote add upstream
https://github.com/apache/airflow.git``
Review Comment:
In the numbered rebase steps, the continuation lines and the nested bullet
list under step 1 are not indented, which breaks the reStructuredText list
structure (the bullets/paragraphs will render outside the "1." item). Indent
the wrapped paragraph lines and the `* If you use ...` bullets to be part of
step 1 (typically 3 spaces past the list marker) so Sphinx renders the list
correctly.
--
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]
