(superset) branch master updated: docs: clarify how `requirements/` should be modified (#33714)

[ma...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

maximebeauchemin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git


The following commit(s) were added to refs/heads/master by this push:
     new da8efd36d7 docs: clarify how `requirements/` should be modified (#33714)
da8efd36d7 is described below

commit da8efd36d7b7d3ba03eed08c81b34731084b2836
Author: Maxime Beauchemin <ma...@gmail.com>
AuthorDate: Fri Jun 6 16:30:27 2025 -0700

    docs: clarify how `requirements/` should be modified (#33714)
---
 requirements/README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/requirements/README.md b/requirements/README.md
new file mode 100644
index 0000000000..29192a1fad
--- /dev/null
+++ b/requirements/README.md
@@ -0,0 +1,13 @@
+## Python dependency logic
+
+In this folder, the `.in` files, in conjunction with the `../pyproject.toml` file (in the root of the repo) are used to generate the pinned requirements as `.txt` files.
+
+To alter the pinned dependency, you can edit/alter the `.in` and `pyproject.toml` files, and then run the following command:
+
+```bash
+./scripts/uv-pip-compile.sh
+```
+
+This will generate the pinned requirements in the `.txt` files, which will be used in our CI/CD pipelines and in the Docker images.
+
+We recommend to everyone in the community to use the pinned requirements in their local development environments, to ensure consistency across different environments, though we don't force requirements as part of our python package semantics to allow flexibility for users to install different versions of the dependencies if they wish.