René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"CONTRIBUTING.md","articleBody":"# Contributing Guide\n\nWe happily welcome contributions to the `databricks-sql-connector` package. We use [GitHub Issues](https://github.com/databricks/databricks-sql-python/issues) to track community reported issues and [GitHub Pull Requests](https://github.com/databricks/databricks-sql-python/pulls) for accepting changes.\n\nContributions are licensed on a license-in/license-out basis.\n\n## Communication\nBefore starting work on a major feature, please reach out to us via GitHub, Slack, email, etc. We will make sure no one else is already working on it and ask you to open a GitHub issue.\nA \"major feature\" is defined as any change that is \u003e 100 LOC altered (not including tests), or changes any user-facing behavior.\nWe will use the GitHub issue to discuss the feature and come to agreement.\nThis is to prevent your time being wasted, as well as ours.\nThe GitHub review process for major features is also important so that organizations with commit access can come to agreement on design.\nIf it is appropriate to write a design document, the document must be hosted either in the GitHub tracking issue, or linked to from the issue and hosted in a world-readable location.\nSpecifically, if the goal is to add a new extension, please read the extension policy.\nSmall patches and bug fixes don't need prior communication.\n\n## Coding Style\nWe follow [PEP 8](https://www.python.org/dev/peps/pep-0008/) with one exception: lines can be up to 100 characters in length, not 79.\n\n## Sign your work\nThe sign-off is a simple line at the end of the explanation for the patch. Your signature certifies that you wrote the patch or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the below (from developercertificate.org):\n\n```\nDeveloper Certificate of Origin\nVersion 1.1\n\nCopyright (C) 2004, 2006 The Linux Foundation and its contributors.\n1 Letterman Drive\nSuite D4700\nSan Francisco, CA, 94129\n\nEveryone is permitted to copy and distribute verbatim copies of this\nlicense document, but changing it is not allowed.\n\n\nDeveloper's Certificate of Origin 1.1\n\nBy making a contribution to this project, I certify that:\n\n(a) The contribution was created in whole or in part by me and I\n    have the right to submit it under the open source license\n    indicated in the file; or\n\n(b) The contribution is based upon previous work that, to the best\n    of my knowledge, is covered under an appropriate open source\n    license and I have the right under that license to submit that\n    work with modifications, whether created in whole or in part\n    by me, under the same open source license (unless I am\n    permitted to submit under a different license), as indicated\n    in the file; or\n\n(c) The contribution was provided directly to me by some other\n    person who certified (a), (b) or (c) and I have not modified\n    it.\n\n(d) I understand and agree that this project and the contribution\n    are public and that a record of the contribution (including all\n    personal information I submit with it, including my sign-off) is\n    maintained indefinitely and may be redistributed consistent with\n    this project or the open source license(s) involved.\n```\n\nThen you just add a line to every git commit message:\n\n```\nSigned-off-by: Joe Smith \u003cjoe.smith@email.com\u003e\nUse your real name (sorry, no pseudonyms or anonymous contributions.)\n```\n\nIf you set your `user.name` and `user.email` git configs, you can sign your commit automatically with `git commit -s`.\n\n## Set up your environment\n\nThis project uses [Poetry](https://python-poetry.org/) for dependency management, tests, and linting.\n\n1. Clone this respository\n2. Run `poetry install`\n\n### Run tests\n\nWe use [Pytest](https://docs.pytest.org/en/7.1.x/) as our test runner. Invoke it with `poetry run python -m pytest`, all other arguments are passed directly to `pytest`.\n\n#### Unit tests\n\nUnit tests do not require a Databricks account.\n\n```bash\npoetry run python -m pytest tests/unit\n```\n#### Only a specific test file\n\n```bash\npoetry run python -m pytest tests/unit/tests.py\n```\n\n#### Only a specific method\n\n```bash\npoetry run python -m pytest tests/unit/tests.py::ClientTestSuite::test_closing_connection_closes_commands\n```\n\n#### e2e Tests\n\nEnd-to-end tests require a Databricks account. Before you can run them, you must set connection details for a Databricks SQL endpoint in your environment:\n\n```bash\nexport host=\"\"\nexport http_path=\"\"\nexport access_token=\"\"\nexport catalog=\"\"\nexport schema=\"\"\n```\n\nOr you can write these into a file called `test.env` in the root of the repository:\n\n```\nhost=\"****.cloud.databricks.com\"\nhttp_path=\"/sql/1.0/warehouses/***\"\naccess_token=\"dapi***\"\nstaging_ingestion_user=\"***@example.com\"\n```\n\nTo see logging output from pytest while running tests, set `log_cli = \"true\"` under `tool.pytest.ini_options` in `pyproject.toml`. You can also set `log_cli_level` to any of the default Python log levels: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`\n\nThere are several e2e test suites available:\n- `PySQLCoreTestSuite`\n- `PySQLLargeQueriesSuite`\n- `PySQLStagingIngestionTestSuite`\n- `PySQLRetryTestSuite.HTTP503Suite` **[not documented]**\n- `PySQLRetryTestSuite.HTTP429Suite` **[not documented]**\n- `PySQLUnityCatalogTestSuite` **[not documented]**\n\nTo execute the core test suite:\n\n```bash\npoetry run python -m pytest tests/e2e/driver_tests.py::PySQLCoreTestSuite\n```\n\nThe `PySQLCoreTestSuite` namespace contains tests for all of the connector's basic features and behaviours. This is the default namespace where tests should be written unless they require specially configured clusters or take an especially long-time to execute by design.\n\nThe `PySQLLargeQueriesSuite` namespace contains long-running query tests and is kept separate. In general, if the `PySQLCoreTestSuite` passes then these tests will as well.\n\nThe `PySQLStagingIngestionTestSuite` namespace requires a cluster running DBR version \u003e 12.x which supports staging ingestion commands.\n\nThe suites marked `[not documented]` require additional configuration which will be documented at a later time.\n\n\n### Code formatting\n\nThis project uses [Black](https://pypi.org/project/black/).\n\n```\npoetry run python3 -m black src --check\n```\n\nRemove the `--check` flag to write reformatted files to disk.\n\nTo simplify reviews you can format your changes in a separate commit.\n\n### Change a pinned dependency version\n\nModify the dependency specification (syntax can be found [here](https://python-poetry.org/docs/dependency-specification/)) in `pyproject.toml` and run one of the following in your terminal:\n\n- `poetry update`\n- `rm poetry.lock \u0026\u0026 poetry install`\n\nSometimes `poetry update` can freeze or run forever. Deleting the `poetry.lock` file and calling `poetry install` is guaranteed to update everything but is usually _slower_ than `poetry update` **if `poetry update` works at all**.\n\n[CONTRIBUTING.md](https://github.com/user-attachments/files/21949827/CONTRIBUTING.md)","author":{"url":"https://github.com/jenniferplothow","@type":"Person","name":"jenniferplothow"},"datePublished":"2025-08-23T14:52:53.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":2},"url":"https://github.com/687/databricks-sql-python/issues/687"}