docs: Add cursor rules file and update contributing documentation#420
Closed
devin-ai-integration[bot] wants to merge 3 commits intomainfrom
Closed
docs: Add cursor rules file and update contributing documentation#420devin-ai-integration[bot] wants to merge 3 commits intomainfrom
devin-ai-integration[bot] wants to merge 3 commits intomainfrom
Conversation
Co-Authored-By: Aaron <AJ> Steers <aj@airbyte.io>
Contributor
Author
🤖 Devin AI EngineerOriginal prompt from Aaron: I'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Aaron ("AJ") Steers (aaronsteers)
requested changes
Mar 13, 2025
Member
Aaron ("AJ") Steers (aaronsteers)
left a comment
Aaron ("AJ") Steers (aaronsteers)
left a comment
There was a problem hiding this comment.
Please accept my suggested wording. Also, I realized the cursor rules file should likewise cross-reference the contributing.md file, since everything in the contributing docs for humans should probably also apply to the robots.
…ules Co-Authored-By: Aaron <AJ> Steers <aj@airbyte.io>
Aaron ("AJ") Steers (aaronsteers)
requested changes
Mar 13, 2025
.cursorrules
Outdated
Comment on lines
+40
to
+51
| * Special handling for `__init__.py` files: | ||
| - Do not auto-sort imports in `__init__.py` files with isort | ||
| - When a module depends on classes defined within the same module, use the isort split directive: | ||
| ```python | ||
| # Import the base class first | ||
| from .transformation import RecordTransformation | ||
|
|
||
| # isort: split | ||
| # Then import the implementations | ||
| from .add_fields import AddFields | ||
| from .remove_fields import RemoveFields | ||
| ``` |
There was a problem hiding this comment.
I believe this guidance is stale and should be fully removed.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Co-Authored-By: Aaron <AJ> Steers <aj@airbyte.io>
Contributor
Author
|
Closing due to inactivity for more than 7 days. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add cursor rules file and update contributing documentation
This PR adds a
.cursorrulesfile to the repository root and updates the contributing documentation to reference it. The cursor rules file includes comprehensive development guidelines covering:These guidelines will help developers follow the project's best practices and avoid common issues when working with the codebase.
Link to Devin run: https://app.devin.ai/sessions/f6708bbaad9642e48a33697ca19aecb3
Requested by: Aaron