Skip to content

Commit c6c49fc

Browse files
Update wording in CONTRIBUTING.md and add cross-reference in cursor rules
Co-Authored-By: Aaron <AJ> Steers <[email protected]>
1 parent 3ae9302 commit c6c49fc

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

.cursorrules

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
Here are some notes for Python CDK development.
22

3+
For comprehensive development guidelines, please also refer to the [CONTRIBUTING.md](./docs/CONTRIBUTING.md) file which contains important information for human developers.
4+
35
## Development Setup
46

57
* Use Poetry for dependency management

docs/CONTRIBUTING.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,11 +90,9 @@ Only Airbyte CDK maintainers can run slash commands. The most common slash comma
9090
The full list of available slash commands can be found in the [slash command dispatch file](https://github.com/airbytehq/airbyte-python-cdk/blob/main/.github/workflows/slash_command_dispatch.yml#L21-L25).
9191

9292
# Appendix: Advanced Topics
93-
## Development Guidelines and Cursor Rules
93+
## Development Guidelines for AI Agents
9494

95-
The Airbyte Python CDK uses specific development guidelines to maintain consistent code organization and avoid common issues. These guidelines are documented in the [.cursorrules](./../.cursorrules) file at the root of the repository.
96-
97-
When working with the CDK codebase, please review the cursor rules to ensure your changes follow the project's development practices, especially regarding import conventions, docstring standards, and code organization.
95+
This repo houses a [`.cursorrules`](./../.cursorrules) file at the root of the repository. This is used to guide AI agents working within the repo. It may also have helpful info for new developers onboarding to the repo.
9896

9997

10098
## Using MockServer in Place of Direct API Access

0 commit comments

Comments
 (0)