QT/superset2
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2026-05-07 08:54:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: consolidate the Superset python package metadata (#27884)

Browse Source
This commit is contained in:
Maxime Beauchemin
2024-04-15 14:44:47 -07:00
committed by GitHub
parent 99c414e4da
commit c225e17a75
12 changed files with 216 additions and 246 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/docs/contributing/local-backend.mdx
View File

@@ -70,7 +70,10 @@ If you have made changes to the FAB-managed templates, which are not built the s
#### Dependencies
If you add a new requirement or update an existing requirement (per the `install_requires` section in `setup.py`) you must recompile (freeze) the Python dependencies to ensure that for CI, testing, etc. the build is deterministic. This can be achieved via,
If you add a new requirement or update an existing requirement (per the
`requirements` section in `pyproject.toml`) you must recompile (freeze) the
Python dependencies to ensure that for CI, testing, etc. the build is deterministic.
This can be achieved via,
```bash
$ python3 -m venv venv

4
docs/docs/contributing/pull-request-guidelines.mdx
View File

@@ -54,7 +54,9 @@ Finally, never submit a PR that will put master branch in broken state. If the P
- Recommended capture tools ([Kap](https://getkap.co/), [LICEcap](https://www.cockos.com/licecap/), [Skitch](https://download.cnet.com/Skitch/3000-13455_4-189876.html))
- If no screenshot is provided, the committers will mark the PR with `need:screenshot` label and will not review until screenshot is provided.
- **Dependencies:** Be careful about adding new dependency and avoid unnecessary dependencies.
- For Python, include it in `setup.py` denoting any specific restrictions and in `requirements.txt` pinned to a specific version which ensures that the application build is deterministic.
- For Python, include it in `pyproject.toml` denoting any specific restrictions and
in `requirements.txt` pinned to a specific version which ensures that the application
build is deterministic.
- For TypeScript/JavaScript, include new libraries in `package.json`
- **Tests:** The pull request should include tests, either as doctests, unit tests, or both. Make sure to resolve all errors and test failures. See [Testing](#testing) for how to run tests.
- **Documentation:** If the pull request adds functionality, the docs should be updated as part of the same PR.