This is an automated email from the ASF dual-hosted git repository.
potiuk 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 afdbb76957b Documentation update of cherry-pick details for users
(#60386)
afdbb76957b is described below
commit afdbb76957bcbf3f9139b35cda722b0516eb2c0b
Author: Srabasti Banerjee <[email protected]>
AuthorDate: Thu Jan 15 07:26:15 2026 -0800
Documentation update of cherry-pick details for users (#60386)
* Fix deprecated sqlalchemy usage for test_processor.py
* Remove deprecate Query usage and upgrade to SQLAlchemy2.0
* Updating files for test_not_previously_skipped_dep.py
* Reverting changes to pyproject.toml files for
test_not_previously_skipped_dep.py
* Reverting changes to pyproject.toml files for
test_not_previously_skipped_dep.py
* Reverting changes to pyproject.toml files for
test_not_previously_skipped_dep.py
* Making changes to test_not_previously_skipped_dep.py
* Making changes to pre-committest_not_previously_skipped_dep.py
* Making changes to pre-commit-config
* Fix pre-commit hook issues hopefully
* Update keycloak provider for conf imports
* Reverting changes from old PR
* pyproject.toml update to use next version
* Adding link for cherry-pick of PRs
* removing changes from old commit
* Update of doc
* Updating __ to _ and adding missing . in few places
---
contributing-docs/05_pull_requests.rst | 24 +++++++++++++-----------
1 file changed, 13 insertions(+), 11 deletions(-)
diff --git a/contributing-docs/05_pull_requests.rst
b/contributing-docs/05_pull_requests.rst
index 22a1aae7113..c426a8526db 100644
--- a/contributing-docs/05_pull_requests.rst
+++ b/contributing-docs/05_pull_requests.rst
@@ -77,11 +77,11 @@ these guidelines:
- Include tests, either as doctests, unit tests, or both, to your pull
request.
- The Airflow repo uses `GitHub Actions
<https://help.github.com/en/actions>`__ to
- run the tests and `codecov <https://codecov.io/gh/apache/airflow>`__ to
track
+ The Airflow repo uses `GitHub Actions
<https://help.github.com/en/actions>`_ to
+ run the tests and `codecov <https://codecov.io/gh/apache/airflow>`_ to
track
coverage. You can set up both for free on your fork. It will help you make
sure you do not
break the build with your PR and that you help increase coverage.
- Also we advise to install locally `prek hooks
<08_static_code_checks.rst#prek-hooks>`__ to
+ Also we advise to install locally `prek hooks
<08_static_code_checks.rst#prek-hooks>`_ to
apply various checks, code generation and formatting at the time you make
a local commit - which
gives you near-immediate feedback on things you need to fix before you
push your code to the PR, or in
many case it will even fix it for you locally so that you can add and
commit it straight away.
@@ -97,8 +97,8 @@ these guidelines:
- We prefer that you ``rebase`` your PR (and do it quite often) rather than
merge. It leads to
easier reviews and cleaner changes where you know exactly what changes
you've done. You can learn more
- about rebase vs. merge workflow in `Rebase and merge your pull request
<https://github.blog/2016-09-26-rebase-and-merge-pull-requests/>`__
- and `Rebase your fork <http://stackoverflow.com/a/7244456/1110993>`__.
Make sure to resolve all conflicts
+ about rebase vs. merge workflow in `Rebase and merge your pull request
<https://github.blog/2016-09-26-rebase-and-merge-pull-requests/>`_
+ and `Rebase your fork <http://stackoverflow.com/a/7244456/1110993>`_. Make
sure to resolve all conflicts
during rebase.
- When merging PRs, Maintainer will use **Squash and Merge** which means
then your PR will be merged as one
@@ -106,7 +106,7 @@ these guidelines:
history for easier review, but if you need to, you can also squash all
commits to reduce the
maintenance burden during rebase.
-- Add an `Apache License <http://www.apache.org/legal/src-headers.html>`__
header to all new files. If you
+- Add an `Apache License <http://www.apache.org/legal/src-headers.html>`_
header to all new files. If you
have ``prek`` installed, prek will do it automatically for you. If you
hesitate to install
prek for your local repository - for example because it takes a few
seconds to commit your changes,
this one thing might be a good reason to convince anyone to install prek.
@@ -115,8 +115,8 @@ these guidelines:
code and tests. Docstring is often sufficient. Make sure to follow the
Sphinx compatible standards.
- Make sure your code fulfills all the
- `static code checks <08_static_code_checks.rst#static-code-checks>`__ we
have in our code. The easiest way
- to make sure of that is - again - to install `prek hooks
<08_static_code_checks.rst#prek-hooks>`__
+ `static code checks <08_static_code_checks.rst#static-code-checks>`_ we
have in our code. The easiest way
+ to make sure of that is - again - to install `prek hooks
<08_static_code_checks.rst#prek-hooks>`_.
- Make sure your PR is small and focused on one change only - avoid adding
unrelated changes, mixing
adding features and refactoring. Keeping to that rule will make it easier
to review your PR and will make
@@ -128,6 +128,8 @@ these guidelines:
big PRs so by splitting it to smaller PRs you actually speed up the review
process and make it easier
for your change to be eventually merged.
+- To learn more about ``cherry-pick`` of PRs, refer to the `Airflow 3
development documentation <../blob/main/dev/README_AIRFLOW3_DEV.md>`_.
+
- Run relevant tests locally before opening PR. Often tests are placed in
the files that are corresponding
to the changed code (for example for ``airflow/cli/cli_parser.py`` changes
you have tests in
``tests/cli/test_cli_parser.py``). However there are a number of cases
where the tests that should run
@@ -142,7 +144,7 @@ these guidelines:
versions. For that purpose we have ``airflow.compat`` package where we
keep back-ported
useful features from newer versions.
-- Adhere to guidelines for commit messages described in this `article
<https://cbea.ms/git-commit/>`__.
+- Adhere to guidelines for commit messages described in this `article
<https://cbea.ms/git-commit/>`_.
This makes the lives of those who come after you (and your future self) a
lot easier.
Gen-AI Assisted contributions
@@ -349,7 +351,7 @@ In such cases we can usually do something like this
self.my_field = my_field
The reason for doing it is that we are working on a cleaning up our code to
have
-`prek hook <../scripts/ci/prek/validate_operators_init.py>`__
+`prek hook <../scripts/ci/prek/validate_operators_init.py>`_
that will make sure all the cases where logic (such as validation and complex
conversion)
is not done in the constructor are detected in PRs.
@@ -382,4 +384,4 @@ you should do:
-----------
If you want to learn what are the options for your development environment,
follow to the
-`Development environments <06_development_environments.rst>`__ document.
+`Development environments <06_development_environments.rst>`_ document.
