-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Introduce basic .cursorrules for this repo #154
Merged
Merged
Conversation
This file contains 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
Generated by 🚫 Danger |
3527786
to
de1c328
Compare
iangmaia
reviewed
Feb 19, 2025
iangmaia
reviewed
Feb 19, 2025
And which commands we can assume are available in our agents for each type of script
- Add backticks to code-like elements for better readability - Standardize formatting of command and code references - Enhance section formatting for improved visual consistency
c623994
to
79454d1
Compare
iangmaia
approved these changes
Feb 19, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this 👍 it looks like a great starting point!
mokagio
pushed a commit
that referenced
this pull request
Feb 21, 2025
* Introduce basic .cursorrules for this repo * Add details about cross-platform considerations And which commands we can assume are available in our agents for each type of script * Add Script Validation section * Improve .cursorrules documentation formatting and clarity - Add backticks to code-like elements for better readability - Standardize formatting of command and code references - Enhance section formatting for improved visual consistency * Add rule about shebang * Reorder sections for consistency
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Since many of us are using Cursor IDE nowadays, I figured I'd share my initial
.cursorrules
files I created while working on this repo.This is a very early draft / version of the rules I asked Cursor itself to come up with after analyzing our codebase of this repo + giving it some additional suggestions for rules about documentation and bash 3.2.57. But I'd love for you to add more ideas to that file so that we can consolidate those rules with our conventions and guidances we want for this repo.
I have considered if this change warrants release notes and have added them to the appropriate section in the.CHANGELOG.md
if necessary