Create AGENTS.md Documentation for Repository Guidelines

[bracesproul]

You're given a task to write a collection of rules, context and guidelines on the repository you're provided. Please gather context on the following categories, then write an AGENTS.md file in the root of the repository.

• General Rules: These are general rules any developer/agent should follow when writing code. It should contain rules such as "When creating new XYZ functions, always first search in the XYZ/ directory to see if one exists, and if not, create it and place it in an existing or new file". Additionally, here is where you'd include context about scripts which are commonly executed, such as linter and formatter scripts.
• Repository Structure: This section is where you'll include high level context about how the repository is laid out, any highly useful and not overly obvious information about how the directories/files are structured, different apps/packages/services inside the repository, etc. Do not include every last detail about the repository contents, only a high level technical overview on the repository structure.
• Dependencies and Installation: This section should include high level context about how to install dependencies, where to install them, package managers, etc. Do not include overly verbose context in this section as most repositories typically have straightforward dependency management.
• Testing Instructions: A general guide on testing in this repository. It should include context such as testing frameworks, roughly what types of modules should be tested, how to run tests, and any other context a developer wouldn't be able to infer by looking at test files on how to write & run tests. Do not include every last detail about testing in this section, only the most used/important context necessary to run tests.

Ensure each category is properly wrapped in opening and closing XML tags. The tags to use are as follows:
<general_rules>
</general_rules>
<repository_structure>
</repository_structure>
<dependencies_and_installation>
</dependencies_and_installation>
<testing_instructions>
</testing_instructions>

It is incredibly important that you ALWAYS wrap your sections in the opening and closing XML tags. Failure to do so will result in an invalid file and will not be accepted.

The file should not contain any other content besides those tags, and the rules/context/instructions they contain. Ensure your rules are thoughtful, concise and actually useful to a developer who's never contributed to the repository before. You can think of it as a more structured and directed CONTRIBUTING.md file.

With all of this in mind, please explore the repository and write this single AGENTS.md file with the rules/context/instructions gathered!

Agent Context

{ "tasks": [ { "id": "72513c65-0129-407c-b9cb-f361e803bb09", "taskIndex": 0, "request": "[original issue]\n**Create AGENTS.md Documentation for Repository Guidelines**\nYou're given a task to write a collection of rules, context and guidelines on the repository you're provided. Please gather context on the following categories, then write an `AGENTS.md` file in the root of the repository.\n\n- **General Rules**: These are general rules any developer/agent should follow when writing code. It should contain rules such as \"When creating new XYZ functions, always first search in the XYZ/ directory to see if one exists, and if not, create it and place it in an existing or new file\". Additionally, here is where you'd include context about scripts which are commonly executed, such as linter and formatter scripts.\n- **Repository Structure**: This section is where you'll include high level context about how the repository is laid out, any highly useful and not overly obvious information about how the directories/files are structured, different apps/packages/services inside the repository, etc. Do not include every last detail about the repository contents, only a high level technical overview on the repository structure.\n- **Dependencies and Installation**: This section should include high level context about how to install dependencies, where to install them, package managers, etc. Do not include overly verbose context in this section as most repositories typically have straightforward dependency management. \n- **Testing Instructions**: A general guide on testing in this repository. It should include context such as testing frameworks, roughly what types of modules should be tested, how to run tests, and any other context a developer wouldn't be able to infer by looking at test files on how to write & run tests. Do not include every last detail about testing in this section, only the most used/important context necessary to run tests.\n\nEnsure each category is properly wrapped in opening and closing XML tags. The tags to use are as follows:\n\n\n\n\n\n\n\n\n\nIt is incredibly important that you ALWAYS wrap your sections in the opening and closing XML tags. Failure to do so will result in an invalid file and will not be accepted.\n\nThe file should not contain any other content besides those tags, and the rules/context/instructions they contain. Ensure your rules are thoughtful, concise and actually useful to a developer who's never contributed to the repository before. You can think of it as a more structured and directed `CONTRIBUTING.md` file.\n\nWith all of this in mind, please explore the repository and write this single `AGENTS.md` file with the rules/context/instructions gathered!", "title": "Create comprehensive AGENTS.md documentation file with repository guidelines", "createdAt": 1752715437006, "completed": true, "planRevisions": [ { "revisionIndex": 0, "plans": [ { "index": 0, "plan": "Create AGENTS.md file in the root directory with four main sections: general_rules, repository_structure, dependencies_and_installation, and testing_instructions, ensuring each section is properly wrapped in XML tags as specified", "completed": true, "summary": "Successfully created the AGENTS.md file in the root directory with all four required sections properly wrapped in XML tags. The file contains:\n\n1. **** section - Documented monorepo development workflow including mandatory make format/lint/test commands, TEST variable usage for specific test files, code quality tools (ruff and mypy), and root-level commands for cross-library operations.\n\n2. **** section - Described the libs/ monorepo layout with all 8 main libraries (checkpoint, checkpoint-postgres, checkpoint-sqlite, cli, langgraph, prebuilt, sdk-js, sdk-py), their purposes, dependency relationships, and key directory structure patterns.\n\n3. **** section - Covered uv as the primary package manager, pyproject.toml and uv.lock dependency management, library interdependencies through uv.sources, and the root-level make install command.\n\n4. **** section - Detailed pytest as the testing framework, asyncio_mode configuration, Docker Compose requirements for PostgreSQL integration tests, make test command usage, test fixtures and conftest.py patterns, and coverage reporting with pytest-cov.\n\nThe file follows the exact XML tag format specified (, , , ) and contains only the tagged sections with no additional content. Each section provides concise, actionable guidance for developers new to the repository while covering all the essential technical details discovered during repository exploration." }, { "index": 1, "plan": "Populate the general_rules section with monorepo development guidelines including the mandatory make format, make lint, and make test commands for each library, TEST variable usage for specific test files, and code quality requirements using ruff and mypy", "completed": false }, { "index": 2, "plan": "Write the repository_structure section describing the libs/ monorepo layout with the 8 main libraries (checkpoint, checkpoint-postgres, checkpoint-sqlite, cli, langgraph, prebuilt, sdk-js, sdk-py), their purposes, and the dependency relationships between libraries", "completed": false }, { "index": 3, "plan": "Document the dependencies_and_installation section covering uv as the primary package manager, pyproject.toml and uv.lock files for dependency management, library interdependencies through uv.sources, and the root-level make install command", "completed": false }, { "index": 4, "plan": "Complete the testing_instructions section detailing pytest as the testing framework, asyncio_mode configuration, Docker Compose requirements for PostgreSQL integration tests, make test command usage, test fixtures and conftest.py patterns, and coverage reporting with pytest-cov", "completed": false } ], "createdAt": 1752715437006, "createdBy": "agent" }, { "revisionIndex": 1, "plans": [ { "index": 0, "plan": "Create AGENTS.md file in the root directory with four main sections: general_rules, repository_structure, dependencies_and_installation, and testing_instructions, ensuring each section is properly wrapped in XML tags as specified", "completed": true, "summary": "Successfully created the AGENTS.md file in the root directory with all four required sections properly wrapped in XML tags. The file contains:\n\n1. **** section - Documented monorepo development workflow including mandatory make format/lint/test commands, TEST variable usage for specific test files, code quality tools (ruff and mypy), and root-level commands for cross-library operations.\n\n2. **** section - Described the libs/ monorepo layout with all 8 main libraries (checkpoint, checkpoint-postgres, checkpoint-sqlite, cli, langgraph, prebuilt, sdk-js, sdk-py), their purposes, dependency relationships, and key directory structure patterns.\n\n3. **** section - Covered uv as the primary package manager, pyproject.toml and uv.lock dependency management, library interdependencies through uv.sources, and the root-level make install command.\n\n4. **** section - Detailed pytest as the testing framework, asyncio_mode configuration, Docker Compose requirements for PostgreSQL integration tests, make test command usage, test fixtures and conftest.py patterns, and coverage reporting with pytest-cov.\n\nThe file follows the exact XML tag format specified (, , , ) and contains only the tagged sections with no additional content. Each section provides concise, actionable guidance for developers new to the repository while covering all the essential technical details discovered during repository exploration." }, { "index": 1, "plan": "Remove all content after the closing tag, specifically the old AGENTS.md content that starts with '# AGENTS Instructions' to ensure the file contains only the four XML-tagged sections as required", "completed": true, "summary": "Successfully removed all content after the closing tag from the AGENTS.md file. The file now contains exactly what was required - only the four XML-tagged sections with no additional content.\n\n**Actions taken:**\n1. Identified that the AGENTS.md file contained both the new XML-tagged content AND the old AGENTS.md content starting with \"# AGENTS Instructions\" after line 112\n2. Applied a patch to remove all content from line 113 onwards, which included the old content with sections like \"# AGENTS Instructions\", \"## Libraries\", \"### Dependency map\", etc.\n3. Verified the file now ends cleanly with the closing tag and contains only 113 lines\n\n**Final file structure:**\n- Lines 1-25: section with monorepo development guidelines\n- Lines 27-59: section with library descriptions and dependencies \n- Lines 61-79: section with uv package manager details\n- Lines 81-112: section with pytest framework information\n- Line 113: Closing tag (file ends here)\n\nThe AGENTS.md file now meets the exact specification: it contains only the four required XML-tagged sections with no other content, as required by the user's instructions that \"The file should not contain any other content besides those tags, and the rules/context/instructions they contain.\"" } ], "createdAt": 1752715653652, "createdBy": "agent" } ], "activeRevisionIndex": 1, "completedAt": 1752715824833, "summary": "I have successfully created the AGENTS.md file with the four required XML-tagged sections and removed all extraneous content. The file now contains only:\n\n1. **** - Monorepo development workflow including mandatory make commands, TEST variable usage, and code quality tools (ruff/mypy)\n2. **** - Overview of the 8 libraries in libs/, their purposes, and dependency relationships \n3. **** - uv package manager usage, pyproject.toml management, and installation process\n4. **** - pytest framework, Docker requirements for PostgreSQL tests, and coverage reporting\n\nThe old AGENTS.md content that was appended after the closing `` tag has been completely removed, ensuring the file contains only the specified XML-tagged sections as required." } ], "activeTaskIndex": 0 } [ "Create AGENTS.md file in the root directory with four main sections: general_rules, repository_structure, dependencies_and_installation, and testing_instructions, ensuring each section is properly wrapped in XML tags as specified", "Populate the general_rules section with monorepo development guidelines including the mandatory make format, make lint, and make test commands for each library, TEST variable usage for specific test files, and code quality requirements using ruff and mypy", "Write the repository_structure section describing the libs/ monorepo layout with the 8 main libraries (checkpoint, checkpoint-postgres, checkpoint-sqlite, cli, langgraph, prebuilt, sdk-js, sdk-py), their purposes, and the dependency relationships between libraries", "Document the dependencies_and_installation section covering uv as the primary package manager, pyproject.toml and uv.lock files for dependency management, library interdependencies through uv.sources, and the root-level make install command", "Complete the testing_instructions section detailing pytest as the testing framework, asyncio_mode configuration, Docker Compose requirements for PostgreSQL integration tests, make test command usage, test fixtures and conftest.py patterns, and coverage reporting with pytest-cov" ]

[rakshi001]

hey @bracesproul i am intreseted in solving this issue , being a beginner in OSS i would like to ask how can i start things please help me out here sir.