From 5d458b8c8a0ac9e85f0545b437ca34839e668738 Mon Sep 17 00:00:00 2001 From: James Hobbs Date: Mon, 21 Sep 2026 18:07:29 +0200 Subject: [PATCH 1/2] docs(agents): check documentation and keep PRs focused Record which docs can go stale (docs/user, docs/dev, README, and the product docs in deepnote/deepnote) so they are updated alongside the change, and ask for small single-purpose pull requests. Co-Authored-By: Claude Opus 5 (1M context) --- CLAUDE.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/CLAUDE.md b/CLAUDE.md index 7ca81553..8225a796 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -75,3 +75,20 @@ You can run a single test using the following format: ```sh TEST_TYPE="unit" TOOLKIT_VERSION="local-build" ./bin/test tests/unit/test_sql_execution.py::TestExecuteSql::test_execute_sql_with_connection_json_with_snowflake_encrypted_private_key ``` + +## Documentation + +Before opening a pull request, check whether the change makes any documentation stale, and update it in the same pull request: + +- `docs/user/` - user-facing toolkit configuration and behavior +- `docs/dev/` - development and internal configuration +- `README.md` - features, installation, and supported versions +- `CONTRIBUTING.md` - contributor and release workflow +- Product documentation for Deepnote Cloud is not in this repository: it lives as Markdown under `docs/` in the public [`deepnote`](https://github.com/deepnote/deepnote) repository and is published at https://deepnote.com/docs. A change that alters what a Deepnote user sees (SQL behavior, integrations, pre-installed packages, supported Python versions) needs a matching pull request there. + +Update only the documentation your change actually affects. + +## Pull Requests + +- Keep each pull request as simple and clean as possible: one purpose, the smallest diff that achieves it, no drive-by refactors or unrelated formatting +- Split anything that does not serve the stated purpose into its own pull request From 37a2e1f756ad58125d64ffa6295fa52c6a8306d5 Mon Sep 17 00:00:00 2001 From: James Hobbs Date: Thu, 8 Oct 2026 12:07:31 +0200 Subject: [PATCH 2/2] docs(agents): drop the Pull Requests section Addresses review feedback: the guidance was subjective, unrelated to the documentation check this change is about, and duplicated the objection already raised on deepnote/tf-infra#493. Co-Authored-By: Claude Opus 5 (1M context) --- CLAUDE.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/CLAUDE.md b/CLAUDE.md index 8225a796..ee5ba7c2 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -87,8 +87,3 @@ Before opening a pull request, check whether the change makes any documentation - Product documentation for Deepnote Cloud is not in this repository: it lives as Markdown under `docs/` in the public [`deepnote`](https://github.com/deepnote/deepnote) repository and is published at https://deepnote.com/docs. A change that alters what a Deepnote user sees (SQL behavior, integrations, pre-installed packages, supported Python versions) needs a matching pull request there. Update only the documentation your change actually affects. - -## Pull Requests - -- Keep each pull request as simple and clean as possible: one purpose, the smallest diff that achieves it, no drive-by refactors or unrelated formatting -- Split anything that does not serve the stated purpose into its own pull request