Skip to content

docs: Starter draft of Windsurf rules#7692

Merged
margaretkennedy merged 10 commits intodeephaven:mainfrom
margaretkennedy:windsurf-rules
Feb 26, 2026
Merged

docs: Starter draft of Windsurf rules#7692
margaretkennedy merged 10 commits intodeephaven:mainfrom
margaretkennedy:windsurf-rules

Conversation

@margaretkennedy
Copy link
Contributor

No description provided.

@margaretkennedy margaretkennedy added documentation Improvements or additions to documentation NoDocumentationNeeded NoReleaseNotesNeeded No release notes are needed. labels Feb 17, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 17, 2026

No docs changes detected for 6e94c58

@margaretkennedy
Copy link
Contributor Author

I'm working on global rules

Copy link
Contributor

@elijahpetty elijahpetty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just two comments

- Verify that described behavior matches the actual implementation.
- Flag any outdated or incorrect information.

4. **Style guide proofreading (based on `.windsurf/rules`):**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add something here about using "-" instead of "--" since windsurf does that a lot?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, that is in the rules file


2. Read the Python documentation file.

3. Convert to Groovy conventions:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we need to be more specific on what the process should be for converting Python to Groovy syntax. Eg, "look at the py/javadocs and adjust code examples accordingly" rather than hallucinating direct equivalents to things that are done differently in Python vs Groovy.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good call

@margaretkennedy margaretkennedy enabled auto-merge (squash) February 25, 2026 20:08
@margaretkennedy margaretkennedy merged commit 4687ba4 into deephaven:main Feb 26, 2026
33 of 34 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Feb 26, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Improvements or additions to documentation NoDocumentationNeeded NoReleaseNotesNeeded No release notes are needed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants