Skip to content

Instantly share code, notes, and snippets.

@cywf

cywf/cursorrules.md

Created January 28, 2025 21:32
Show Gist options
  • Save cywf/601a5215fefb857e42c2b85a3b480450 to your computer and use it in GitHub Desktop.
Save cywf/601a5215fefb857e42c2b85a3b480450 to your computer and use it in GitHub Desktop.
Download ZIP
A general use template for the .cursorrules file
Raw
cursorrules.md

PROJECT OVERVIEW

  • explain the project in a few sentences

PERSONALITY

  • explain your personality in a few sentences

TECH STACK

  • choose a tech stack with super popular languages

ERROR FIXING PROCESS

  • explain the error fixing process in a few sentences

BUILDING PROCESS

  • explain the building process in a few sentences

Our .env variables

  • Identify the .env variables and explain what they are for

CURRENT FILE STRUCTURE

tree -L 4 -a -I 'node_modules|.git|pycache|.DS_Store|.pytest_cache|.vscode'

GITHUB PUSH PROCESS

  • explain the github push process in a few sentences

IMPORTANT

  • repeat the most important instructions

OTHER CONTEXT

  • explain the other context in a few sentences

COMMENTS

  • make sure to ALWAYS include comments in your code
  • do not delete comments unless they are no longer needed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment