Skip to content
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 6 commits into from
Feb 19, 2025
Merged

Introduce basic .cursorrules for this repo #154

merged 6 commits into from
Feb 19, 2025

Conversation

AliSoftware
Copy link
Contributor

@AliSoftware AliSoftware commented Feb 19, 2025

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.

@dangermattic
Copy link

dangermattic commented Feb 19, 2025

1 Warning
⚠️ Please add an entry in the CHANGELOG.md file to describe the changes made by this PR

Generated by 🚫 Danger

@AliSoftware AliSoftware self-assigned this Feb 19, 2025
@AliSoftware AliSoftware requested a review from a team February 19, 2025 10:16
@AliSoftware AliSoftware requested a review from iangmaia February 19, 2025 16:00
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
Copy link
Contributor

@iangmaia iangmaia left a 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!

@AliSoftware AliSoftware merged commit f28522b into trunk Feb 19, 2025
17 checks passed
@AliSoftware AliSoftware deleted the cursor-rules branch February 19, 2025 16:28
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants