[GitHub] [airflow] uranusjr commented on a change in pull request #22204: Add description on the vendoring process we use

[GitBox <gi...@apache.org>]

uranusjr commented on a change in pull request #22204:
URL: https://github.com/apache/airflow/pull/22204#discussion_r825371901



##########
File path: airflow/_vendor/README.md
##########
@@ -0,0 +1,37 @@
+# Vendor package
+
+## What vendored packages are for
+
+The `airlfow._vendor` package is foreseen for vendoring in packages, that we have to modify ourselves
+because authors of the packages do not have time to modify them themselves. This is often temporary
+and once the packages implement fixes that we need, and then we remove the packages from
+the _vendor package.
+
+All Vendored libraries must follow these rules:
+
+1. Vendored libraries must be pure Python--no compiling.
+2. Source code for the libary is included in this directory.
+3. License must be included in this repo and in the [LICENSE](../../LICENSE) file and in the
+   [licenses](../../licenses) folder.
+4. Requirements of the library become requirements of airflow core.
+5. Version of the library should be included in the [vendor.md](vendor.md) file.
+6. No modifications to the library may be made in the initial commit.
+7. Apply the fixes necessary to use the vendored library as separate commits - each package separately,
+   so that they can be cherry-picked later if we upgrade the vendored package. Changes to airflow code to
+   use the vendored packages should be applied as separate commits/PRs.
+8. The `_vendor` packages should be excluded from any refactorings, static checks and automated fixes.
+
+## Adding and upgrading a vendored package
+
+Way to vendor a library or update a version:
+
+1. Update ``vendor.txt`` with the library, version, and SHA256 (`pypi` provides gashes as of recently)

Review comment:
       Should this be `vendor.md`?




-- 
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: commits-unsubscribe@airflow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org