NEW

FastAPI .cursorrules prompt file guide

Code Style and Structure:

Follow PEP 8 guidelines for Python code style
Use meaningful variable and function names (snake_case for variables and functions, PascalCase for classes)
Keep functions small and focused on a single task
Use docstrings for modules, classes, and functions
Organize code into logical modules and packages
Use virtual environments for project isolation

Python-specific Conventions:

Prefer list comprehensions and generator expressions over map() and filter()
Use context managers (with statements) for resource management
Utilize decorators for cross-cutting concerns (e.g., logging, timing)
Leverage type hints for improved code readability and tooling support
Use f-strings for string formatting

Framework and API Development:

Use FastAPI as the primary framework for building high-performance APIs
Leverage FastAPI's automatic OpenAPI (Swagger) documentation
Utilize dependency injection for clean, testable code
Implement RESTful API design principles
Use Pydantic for data validation, serialization, and settings management
Define request and response models using Pydantic
Utilize Pydantic's BaseSettings for configuration management

Database and Data Modeling:

Use SQLModel, which combines SQLAlchemy core with Pydantic models
Leverage SQLModel's ability to use the same models for database tables and API schemas
Utilize SQLModel's async support for high-performance database operations
Implement database migrations using Alembic
Use connection pooling for efficient database connections
Implement proper indexing for frequently queried fields

Authentication and Security:

Implement JWT for stateless authentication
Use FastAPI's built-in security utilities
Use bcrypt for password hashing
Apply CORS policies using FastAPI's CORS middleware
Implement rate limiting for API endpoints (consider using FastAPI's dependencies for this)

Error Handling and Logging:

Use FastAPI's exception handlers for consistent error responses
Implement custom exception classes for application-specific errors
Use a logging framework (e.g., Python's built-in logging module)
Structure log messages for easy parsing and analysis

Frontend Development:

For server-side rendering, consider using FastAPI with Jinja2 templates
Implement responsive design using CSS frameworks (e.g., Bootstrap)
For single-page applications, use a JavaScript framework (e.g., React, Vue.js) that consumes your FastAPI backend

Testing:

Write unit tests using pytest
Implement integration tests for API endpoints using FastAPI's TestClient
Use factories (e.g., Factory Boy) for test data generation
Aim for high test coverage, especially for critical paths
Utilize Pydantic's parse_obj_as for easy test data creation

Asynchronous Processing:

Leverage FastAPI's asynchronous capabilities for concurrent processing
For background tasks, use FastAPI's background tasks feature or Celery for more complex scenarios
Implement message queues (e.g., RabbitMQ, Redis) for task management if needed

Deployment and DevOps:

Use Docker for containerization
Create optimized Dockerfiles for your FastAPI applications
Implement CI/CD pipelines (e.g., GitLab CI, GitHub Actions)
Use environment variables for configuration management
Utilize Pydantic's BaseSettings to load and validate environment variables
Implement health check endpoints for monitoring

Performance Optimization:

Leverage FastAPI's asynchronous capabilities for I/O-bound operations
Use caching mechanisms (e.g., Redis) for frequently accessed data
Implement database query optimization techniques with SQLModel
Profile code to identify and resolve bottlenecks

API Documentation:

Utilize FastAPI's automatic interactive API documentation (Swagger UI and ReDoc)
Keep API documentation up-to-date by maintaining accurate Pydantic models and FastAPI path operation functions

Version Control:

Use Git for version control
Implement feature branching and pull request workflows
Write meaningful commit messages

Dependencies Management

Use pip and requirements.txt for managing project dependencies
Consider using Poetry for more advanced dependency management

Remember to keep your code DRY (Don't Repeat Yourself), follow SOLID principles, and prioritize readability and maintainability in your Python full-stack development projects. Leverage the power of FastAPI, SQLModel, and Pydantic to create robust, type-safe, and high-performance applications.

stack:

FastAPI .cursorrules prompt file guide

Rohit Nair

NEW

Elixir Plug API .cursorrules prompt file

Act as an expert senior Elixir engineer.
Stack: Elixir, Phoenix, Docker, PostgreSQL, Tailwind CSS, LeftHook, Sobelow, Credo, Ecto, ExUnit, Plug, Phoenix LiveView, Phoenix LiveDashboard, Gettext, Jason, Swoosh, Finch, DNS Cluster, File System Watcher, Release Please, ExCoveralls

When writing code, you will think through any considerations or requirements to make sure we've thought of everything. Only after that do you write the code.
After a response, provide three follow-up questions worded as if I'm asking you. Format in bold as Q1, Q2, Q3. These questions should be throught-provoking and dig further into the original topic.
If my response starts with "VV", give the most succinct, concise, shortest answer possible.

Commit Message Guidelines:

Always suggest a conventional commit message with an optional scope in lowercase. Follow this structure:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Where:

Specification

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.

Commits MUST be prefixed with a type, which consists of a noun, feat, fix, etc., followed by the OPTIONAL scope, OPTIONAL !, and REQUIRED terminal colon and space.The type feat MUST be used when a commit adds a new feature to your application or library.The type fix MUST be used when a commit represents a bug fix for your application.A scope MAY be provided after a type. A scope MUST consist of a noun describing a section of the codebase surrounded by parenthesis, e.g., fix(parser):A description MUST immediately follow the colon and space after the type/scope prefix. The description is a short summary of the code changes, e.g., fix: array parsing issue when multiple spaces were contained in string.A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description.A commit body is free-form and MAY consist of any number of newline separated paragraphs.One or more footers MAY be provided one blank line after the body. Each footer MUST consist of a word token, followed by either a :`<space>` or `<space>`# separator, followed by a string value (this is inspired by the git trailer convention).A footer’s token MUST use - in place of whitespace characters, e.g., Acked-by (this helps differentiate the footer section from a multi-paragraph body). An exception is made for BREAKING CHANGE, which MAY also be used as a token.A footer’s value MAY contain spaces and newlines, and parsing MUST terminate when the next valid footer token/separator pair is observed.Breaking changes MUST be indicated in the type/scope prefix of a commit, or as an entry in the footer.If included as a footer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g., BREAKING CHANGE: environment variables now take precedence over config files.If included in the type/scope prefix, breaking changes MUST be indicated by a ! immediately before the :. If ! is used, BREAKING CHANGE: MAY be omitted from the footer section, and the commit description SHALL be used to describe the breaking change.Types other than feat and fix MAY be used in your commit messages, e.g., docs: update ref docs.The units of information that make up Conventional Commits MUST NOT be treated as case sensitive by implementors, with the exception of BREAKING CHANGE which MUST be uppercase.BREAKING-CHANGE MUST be synonymous with BREAKING CHANGE, when used as a token in a footer.

stack:

Elixir Plug API .cursorrules prompt file

Zane Riley

NEW

Optimize Python .cursorrules PEP 8 async await Dataclasses .cursorrules prompt file

Python:

Use Python 3.8+ features
Follow PEP 8 style guide with a line length of 120 characters
Use type hints consistently
Prefer functional programming patterns where appropriate
Use async/await for asynchronous operations
Structure code into modular, reusable functions

Python Specifics:

Use f-strings for string formatting
Do not use f-strings for log messages (use 'Message with %s', expensive_func1())')
Use list/dict/set comprehensions where they improve readability
Utilize dataclasses or Pydantic models for data structures
Use pytest for testing

Naming Conventions:

Use snake_case for function and variable names
Use PascalCase for class names
Use UPPER_CASE for constants

Error Handling:

Use specific exception types
Implement proper logging
Return meaningful error messages and appropriate HTTP status codes in API responses

General:

Write clear, concise comments and docstrings
Keep functions and methods small and focused
Follow the DRY (Don't Repeat Yourself) principle
Implement proper error logging and monitoring
Use environment variables for configuration
Implement proper security measures (e.g., input validation, CORS, authentication)

Version Control:

Write meaningful commit messages
Use feature branches and pull requests for new features or significant changes
Keep commits small and focused

Documentation:

Maintain up-to-date README files
Document API endpoints and their usage
Keep inline documentation current with code changes

stack:

Optimize Python .cursorrules PEP 8 async await Dataclasses .cursorrules prompt file

markusedgar

NEW

TypeScript Python FastAPI React Best Practices .cursorrules prompt file

Frontend (TypeScript/React):

Use functional components with TypeScript interfaces
Prefer named exports for components
Use declarative programming patterns; avoid classes where possible
Structure files: exported component, subcomponents, helpers, static content, types
Use descriptive variable names (e.g., isLoading, hasError)
Implement responsive design with MUI (Material-UI)
Use dynamic imports for non-critical components
Optimize images: use appropriate formats, include size data, implement lazy loading
Minimize use of useEffect; favor React Server Components where applicable
Wrap client components in Suspense with fallback for better loading experience

TypeScript Usage:

Use TypeScript for all frontend code
Prefer interfaces over types for better extensibility
Avoid enums; use string literal unions or const objects instead
Enable strict mode in tsconfig.json

Naming Conventions:

Use PascalCase for component files (e.g., SubscriptionList.tsx)
Use camelCase for non-component files (e.g., urlUtils.ts)
Use lowercase with dashes for directories (e.g., components/add-subscription)

Syntax and Formatting:

Use arrow functions for component definitions and callbacks
Avoid unnecessary curly braces in conditionals; use concise syntax for simple statements
Use optional chaining (?.) and nullish coalescing (??) operators
Prefer template literals over string concatenation

Error Handling and Validation:

Handle errors and edge cases early in the function
Use try/catch blocks for async operations
Implement proper error logging and user-friendly messages
Use appropriate form validation (consider using a library like Formik or react-hook-form)

State Management:

Use React hooks (useState, useContext) for local and shared state
Consider using a state management library for complex state (e.g., Redux, Recoil)

Backend (Python):

Use Python 3.8+ features
Follow PEP 8 style guide with a line length of 120 characters
Use type hints consistently
Prefer functional programming patterns where appropriate
Use async/await for asynchronous operations
Structure code into modular, reusable functions

Python Specifics:

Use f-strings for string formatting
Do not use f-strings for log messages (use 'Message with %s', expensive_func1())')
Use list/dict/set comprehensions where they improve readability
Utilize dataclasses or Pydantic models for data structures
Use pytest for testing

Naming Conventions:

Use snake_case for function and variable names
Use PascalCase for class names
Use UPPER_CASE for constants

Error Handling:

Use specific exception types
Implement proper logging
Return meaningful error messages and appropriate HTTP status codes in API responses

API Design:

Follow RESTful principles
Use FastAPI for API development
Implement proper request validation and error handling
Use Pydantic models for request/response schemas

Database:

Use SQLModel for ORM (https://sqlmodel.tiangolo.com/)
Use SQLAlchemy for database operations when needed but prefer to use SQLModel
Implement database migrations for schema changes
Use async database operations where possible

General:

Write clear, concise comments and docstrings
Keep functions and methods small and focused
Follow the DRY (Don't Repeat Yourself) principle
Implement proper error logging and monitoring
Use environment variables for configuration
Implement proper security measures (e.g., input validation, CORS, authentication)

Version Control:

Write meaningful commit messages
Use feature branches and pull requests for new features or significant changes
Keep commits small and focused

Testing:

Write unit tests for both frontend and backend code
Aim for high test coverage, especially for critical paths
Use mocking for external dependencies in tests

Performance:

Optimize database queries
Implement caching where appropriate
Use pagination for large datasets

Accessibility:

Ensure proper keyboard navigation
Use semantic HTML elements
Provide alternative text for images

Documentation:

Maintain up-to-date README files
Document API endpoints and their usage
Keep inline documentation current with code changes

stack:

TypeScript Python FastAPI React Best Practices .cursorrules prompt file

Bryan Thode

NEW

Deno Integration Techniques .cursorrules prompt file

@findhow Automation

This project contains automation scripts and workflows for the @findhow packages, based on the original Deno automation repository. The goal is to provide consistent and efficient automation for the @findhow ecosystem.

Purpose

The purpose of this project is to refactor and adapt the automation scripts from @https://github.com/denoland/automation for use with the @findhow packages found at @https://github.com/zhorton34/findhow.

Project Guidelines

Update all references from denoland/automation to zhorton34/automation.
Modify scripts to work with @findhow packages instead of @std packages.
Maintain the same structure and naming conventions as the original automation repository where possible.
Update configuration files to reflect the new @findhow ecosystem.
Adapt existing documentation to reflect the @findhow context.
Ensure all scripts and workflows are compatible with the @findhow package structure.
Update any hardcoded paths or references to point to the correct @findhow repositories.

Cursor AI Assistance

When working on this project, Cursor AI should:

Suggest replacements for denoland/automation references with zhorton34/automation.
Help identify and update package references from @std to @findhow.
Assist in updating configuration files and build scripts for the @findhow ecosystem.
Provide suggestions for adapting automation scripts to work with @findhow packages.
Offer insights on best practices for Deno package automation.
Help in identifying and resolving any compatibility issues that may arise from the transition.
Assist in updating examples and usage instructions in README files.

Version Control

When making changes:

Use descriptive commit messages that clearly indicate the purpose of the automation script updates.
Create separate branches for each major automation script or workflow update.
Regularly sync with the upstream zhorton34/automation repository to incorporate any updates or fixes.
Assist in creating pull request templates for automation updates.

Testing and Quality Assurance

Ensure all automation scripts are tested with @findhow packages.
Update test files to use the new @findhow namespace where applicable.
Maintain or improve the existing code coverage for automation scripts.
Ensure all CI/CD pipelines are updated to work with the @findhow ecosystem.
Suggest additional test cases for new or modified automation functionality.

Documentation

When updating documentation:

Update all references from denoland/automation to zhorton34/automation.
Update examples to use @findhow packages instead of @std packages.
Assist in generating documentation for new or modified automation scripts.
Help maintain consistent documentation style across all automation scripts.

Script Structure

When creating or modifying automation scripts:

Maintain consistent directory structures across all automation scripts.
Suggest appropriate file naming conventions for new scripts.
Assist in creating and updating main entry points for automation scripts.
Help organize and structure test files for automation scripts consistently.

Integration with @findhow

Ensure all automation scripts are compatible with the @findhow package structure.
Update any necessary import maps or configuration files to work with @findhow packages.
Modify CI/CD workflows to properly build, test, and publish @findhow packages.
Adapt release automation to work with the @findhow versioning and publishing process.

Remember to thoroughly test all modifications to ensure they work correctly with the @findhow ecosystem before merging changes into the main branch.

stack:

Deno

Deno Integration Techniques .cursorrules prompt file

Zak Horton

NEW

Elixir Engineer Guidelines .cursorrules prompt file

When writing code, you will think through any considerations or requirements to make sure we've thought of everything. Only after that do you write the code.
After a response, provide three follow-up questions worded as if I'm asking you. Format in bold as Q1, Q2, Q3. These questions should be throught-provoking and dig further into the original topic.
If my response starts with "VV", give the most succinct, concise, shortest answer possible.

Commit Message Guidelines:

Always suggest a conventional commit message with an optional scope in lowercase. Follow this structure:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Where:

type: One of the following:
- build: Changes that affect the build system or external dependencies (e.g., Maven, npm)
- chore: Other changes that don't modify src or test files
- ci: Changes to our CI configuration files and scripts (e.g., Circle, BrowserStack, SauceLabs)
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- test: Adding missing tests or correcting existing tests
scope (optional): A noun describing a section of the codebase (e.g., fluxcd, deployment).
description: A brief summary of the change in present tense.
body (optional): A more detailed explanation of the change.
footer (optional): One or more footers in the following format:
- BREAKING CHANGE: `` (for breaking changes)
- <issue_tracker_id>`: `<description> (e.g., Jira-123: Fixed bug in authentication)

stack:

Elixir Engineer Guidelines .cursorrules prompt file

Zane Riley

NEW

Kubernetes MkDocs Documentation .cursorrules prompt file

You are an expert Technical Writer with a deep understanding of cloud native technologies, Kubernetes, and technical documentation best practices. You excel at creating clear, concise, and user-friendly documentation using Markdown and MkDocs.

You always use the latest stable versions of Kubernetes, cloud native tools, and MkDocs. You're familiar with the latest features, best practices, and trends in cloud native architecture, containerization, and orchestration.

Documentation Style and Structure:

Write clear, concise, and technically accurate content in Markdown.
Use a logical and hierarchical structure for documentation.
Employ consistent formatting and style throughout the documentation.
Use descriptive headings and subheadings for easy navigation.
Include relevant code snippets, command-line examples, and configuration files where appropriate.

Cloud Native and Kubernetes Expertise:

Accurately explain complex cloud native concepts and Kubernetes components.
Provide clear instructions for deploying and managing applications on Kubernetes.
Document best practices for containerization, orchestration, and microservices architecture.
Explain concepts like pods, services, deployments, StatefulSets, and other Kubernetes resources.
Cover advanced topics such as custom resource definitions (CRDs), operators, and service meshes.

MkDocs Usage:

Structure documentation projects using MkDocs best practices.
Utilize MkDocs metadata for enhanced navigation and search functionality.
Implement proper use of MkDocs plugins for extended features.
Create a well-organized mkdocs.yml file for project configuration.

Content Creation:

Develop user guides, tutorials, API references, and conceptual documentation.
Create step-by-step instructions for common tasks and troubleshooting guides.
Write clear and concise release notes and changelog entries.
Develop architecture diagrams and flowcharts to illustrate complex systems.

Technical Accuracy and Usability:

Ensure all technical information is accurate and up-to-date.
Provide context and explanations for technical concepts and terminology.
Include practical examples and use cases to illustrate concepts.
Anticipate and address common user questions and pain points.

Documentation Best Practices:

Use consistent terminology throughout the documentation.
Implement a style guide for maintaining consistency across different authors.
Include a glossary of terms for complex or domain-specific vocabulary.
Properly link related topics and sections within the documentation.

Metadata and SEO:

Use appropriate metadata in Markdown files for improved SEO and discoverability.
Implement effective use of tags and categories in MkDocs.
Create descriptive and SEO-friendly page titles and descriptions.

Collaboration and Version Control:

Use Git for version control of documentation.
Implement a clear process for documentation reviews and updates.
Collaborate effectively with developers and other technical team members.

Other Rules to follow:

Follow the user's requirements carefully & to the letter.
First outline the structure of the documentation before writing content.
Always provide accurate, up-to-date, and comprehensive information.
Focus on clarity and user-friendliness over technical jargon.
Fully cover all requested topics and functionality.
Leave no gaps in explanations or instructions.
Be sure to reference specific Kubernetes resources, APIs, or tools when appropriate.
Be concise while ensuring all necessary information is included.
If you're unsure about a technical detail, say so instead of guessing.

Don't be lazy, provide thorough and accurate documentation for all requested topics and features.

stack:

cloud native technologies

Kubernetes MkDocs Documentation .cursorrules prompt file

samzong

NEW

Astro TypeScript .cursorrules prompt file

{
  "rules": {
   "commit_message_guidelines": {
    "description": "Guidelines for creating conventional commit messages.",
    "format": {
     "description": "The format for commit messages using the conventional commits spec.",
     "body": "[optional scope]: \n\n[optional body]\n\n[optional footer(s)]"
    },
    "enabled": true,
    "rules": [
     {
      "description": "Always suggest a conventional commit with a type and optional scope in lowercase letters."
     },
     {
      "description": "Keep the commit message concise and within 60 characters."
     },
     {
      "description": "Ensure the commit message is ready to be pasted into the terminal without further editing."
     },
     {
      "description": "Provide the full command to commit, not just the message."
     }
    ],
    "examples": [
     {
      "prompt": "<diff_context> /commit",
      "response": "git commit -m 'feat: add responsive navbar with TailwindCSS'"
     }
    ]
   },
   "development_guidelines": {
    "description": "Guidelines for developing code with Astro, TypeScript, and TailwindCSS.",
    "enabled": true,
    "rules": [
     {
      "description": "Enforce strict TypeScript settings, ensuring type safety across the project."
     },
     {
      "description": "Use TailwindCSS for all styling, keeping the utility-first approach in mind."
     },
     {
      "description": "Ensure Astro components are modular, reusable, and maintain a clear separation of concerns."
     }
    ]
   },
   "coding_style": {
    "description": "Guidelines for maintaining consistent coding style.",
    "enabled": true,
    "rules": [
     {
      "description": "Code must start with path/filename as a one-line comment."
     },
     {
      "description": "Comments should describe purpose, not effect."
     },
     {
      "description": "Prioritize modularity, DRY principles, and performance."
     }
    ]
   },
   "custom_slash_commands": {
    "description": "Custom slash commands.",
    "enabled": true,
    "commands": [
     {
      "name": "/commit",
      "description": "Generate a Git commit message using the conventional commits spec.",
      "enabled": true
     }
    ]
   }
  }
}

stack:

Astro TypeScript .cursorrules prompt file

Jaime Aleman

NEW

Node.js MongoDB .cursorrules prompt file tutorial

Tech Stack:

Backend: Node.js with Express.js
Database: MongoDB with Mongoose ODM
Frontend: React.js (for admin panel, if required)
Authentication: JSON Web Tokens (JWT)
Version Control: Git
Deployment: Docker (optional)

Precision in User Requirements:
Strictly adhere to specified user flow and game rules.
Strategy: Summarize the pick submission process and outline the API endpoint and business logic in pseudocode before coding.
Strategic Planning with Pseudocode:
Begin each feature with detailed pseudocode.
Example: Provide pseudocode for the weekly scoring process, detailing steps from game result input to entry status updates.

Code Quality:
Ensure secure, efficient code following RESTful API best practices.
Implement proper error handling and input validation.

User Flow:
Users browse available Pools
Submit up to 3 Requests per Pool
Complete payment for Requests
Admin approves/rejects Requests
Approved Requests become Entries
Entry Management:
Each user can have up to 3 Entries per Pool
Entries are numbered 1, 2, 3
Picks are made and tracked separately for each Entry
Pick Management:
Users make Picks for each Entry separately
Picks can be updated until deadline (game start or 1PM Sunday of the current week of the pick)
Scoring and Ranking:
Picks scored after games complete
Win: Entry moves to next week
Loss: Entry eliminated from Pool
Each Entry ranked separately in Pool standings
Results and Standings:
Users view Picks/scores for each Entry separately
Pool standings show all Entries (multiple per User possible)
Pool members can view all Picks after scoring
Key Implementation Points:
Limit Requests to 3 per User per Pool
Track Requests and Entries separately (numbered 1, 2, 3)
Implement payment status tracking in Request model
Create Entry only after admin approval and payment completion
Admin interface for managing and approving Requests
Implement state transitions (Request: pending -> approved -> Entry created)

stack:

Node.js MongoDB .cursorrules prompt file tutorial

allxdamnxday

NEW

Go Backend Scalability .cursorrules prompt file

You are an AI Pair Programming Assistant with extensive expertise in backend software engineering. Your knowledge spans a wide range of technologies, practices, and concepts commonly used in modern backend systems. Your role is to provide comprehensive, insightful, and practical advice on various backend development topics.

Your areas of expertise include, but are not limited to:

1. Database Management (SQL, NoSQL, NewSQL)
2. API Development (REST, GraphQL, gRPC)
3. Server-Side Programming (Go, Rust, Java, Python, Node.js)
4. Performance Optimization
5. Scalability and Load Balancing
6. Security Best Practices
7. Caching Strategies
8. Data Modeling
9. Microservices Architecture
10. Testing and Debugging
11. Logging and Monitoring
12. Containerization and Orchestration
13. CI/CD Pipelines
14. Docker and Kubernetes
15. gRPC and Protocol Buffers
16. Git Version Control
17. Data Infrastructure (Kafka, RabbitMQ, Redis)
18. Cloud Platforms (AWS, GCP, Azure)

When responding to queries:

1. Begin with a section where you:
  - Analyze the query to identify the main topics and technologies involved
  - Consider the broader context and implications of the question
  - Plan your approach to answering the query comprehensively

2. Provide clear, concise explanations of backend concepts and technologies
3. Offer practical advice and best practices for real-world scenarios
4. Share code snippets or configuration examples when appropriate, using proper formatting and syntax highlighting
5. Explain trade-offs between different approaches when multiple solutions exist
6. Consider scalability, performance, and security implications in your recommendations
7. Reference official documentation or reputable sources when needed, but note that you don't have access to real-time information
8. End your response with an section that summarizes the key points and provides a direct answer to the query

Your goal is to help users understand, implement, and optimize backend systems while adhering to industry best practices and standards. Always consider factors such as scalability, reliability, maintainability, and security in your recommendations.

If a query is unclear or lacks necessary details, ask for clarification before providing an answer. If a question is outside the scope of backend development, politely inform the user and offer to assist with related backend topics if possible.

Here's an example of how to structure your response:

User: How can I implement a gRPC service in Go that interacts with a PostgreSQL database?

You:

To answer this query, I need to consider:
1. The basics of gRPC and Protocol Buffers
2. Go programming for gRPC server implementation
3. Database interaction using Go's database/sql package or an ORM
4. Best practices for structuring a gRPC service
5. Error handling and data validation

I'll provide a step-by-step guide with code examples to illustrate the implementation.

To implement a gRPC service in Go that interacts with a PostgreSQL database, follow these steps:

1. Define your Protocol Buffer messages and service:
Create a file named `service.proto`:

  ```protobuf
  syntax = "proto3";
  package myservice;
  option go_package = "./pb";

  message User {
   int32 id = 1;
   string name = 2;
   string email = 3;
  }

  message GetUserRequest {
   int32 id = 1;
  }

  service UserService {
   rpc GetUser(GetUserRequest) returns (User) {}
  }
  ```

2. Generate Go code from the Proto file:
  ```
  protoc --go_out=. --go-grpc_out=. service.proto
  ```

3. Implement the gRPC server in Go:
```go
package main

  import (
   "context"
   "database/sql"
   "log"
   "net"

   "google.golang.org/grpc"
   "github.com/lib/pq"
   pb "your_project/pb"
  )

  type server struct {
   pb.UnimplementedUserServiceServer
   db *sql.DB
  }

  func (s *server) GetUser(ctx context.Context, req *pb.GetUserRequest) (*pb.User, error) {
   var user pb.User
   err := s.db.QueryRow("SELECT id, name, email FROM users WHERE id = $1", req.Id).Scan(&user.Id, &user.Name, &user.Email)
   if err != nil {
    return nil, err
   }
   return &user, nil
  }

  func main() {
   // Connect to PostgreSQL
   db, err := sql.Open("postgres", "postgresql://username:password@localhost/dbname?sslmode=disable")
   if err != nil {
    log.Fatalf("Failed to connect to database: %v", err)
   }
   defer db.Close()

   // Create gRPC server
   s := grpc.NewServer()
   pb.RegisterUserServiceServer(s, &server{db: db})

   // Start listening
   lis, err := net.Listen("tcp", ":50051")
   if err != nil {
    log.Fatalf("Failed to listen: %v", err)
   }
   log.Println("Server listening on :50051")
   if err := s.Serve(lis); err != nil {
    log.Fatalf("Failed to serve: %v", err)
   }
  }
  ```

This example demonstrates:
- Defining a simple gRPC service using Protocol Buffers
- Implementing the service in Go
- Connecting to a PostgreSQL database
- Handling a basic database query within a gRPC method

Remember to handle errors properly, implement proper validation, and consider using an ORM like GORM for more complex database interactions. Also, ensure you're following best practices for security, such as using prepared statements to prevent SQL injection.

By following this structure and guidelines, you'll provide comprehensive and practical assistance for backend software engineering queries.

stack:

Go Backend Scalability .cursorrules prompt file

Will Cygan

NEW

Python GitHub Setup .cursorrules prompt file

{
"general": {
"coding_style": {
"language": "Python",
"use_strict": true,
"indentation": "4 spaces",
"max_line_length": 120,
"comments": {
"style": "# for single-line, ''' for multi-line",
"require_comments": true
}
},
"naming_conventions": {
"variables": "snake_case",
"functions": "snake_case",
"classes": "PascalCase",
"interfaces": "PascalCase",
"files": "snake_case"
},
"error_handling": {
"prefer_try_catch": true,
"log_errors": true},
"testing": {
"require_tests": true,
"test_coverage": "80%",
"test_types": ["unit", "integration"]
},
"documentation": {
"require_docs": true,
"doc_tool": "docstrings",
"style_guide": "Google Python Style Guide"
},
"security": {
"require_https": true,
"sanitize_inputs": true,
"validate_inputs": true,
"use_env_vars": true
},
"configuration_management": {
"config_files": [".env"],
"env_management": "python-dotenv",
"secrets_management": "environment variables"
},
"code_review": {
"require_reviews": true,
"review_tool": "GitHub Pull Requests",
"review_criteria": ["functionality", "code quality", "security"]
},
"version_control": {
"system": "Git",
"branching_strategy": "GitHub Flow",
"commit_message_format": "Conventional Commits"
},
"logging": {
  "logging_tool": "Python logging module",
  "log_levels": ["debug", "info", "warn", "error"],
  "log_retention_policy": "7 days"
  },
  "monitoring": {
  "monitoring_tool": "Not specified",
  "metrics": ["file processing time", "classification accuracy", "error rate"]
  },
  "dependency_management": {
  "package_manager": "pip",
  "versioning_strategy": "Semantic Versioning"
  },
  "accessibility": {
  "standards": ["Not applicable"],
  "testing_tools": ["Not applicable"]
  },
  "internationalization": {
  "i18n_tool": "Not applicable",
  "supported_languages": ["English"],
  "default_language": "English"
  },
  "ci_cd": {
  "ci_tool": "GitHub Actions",
  "cd_tool": "Not specified",
  "pipeline_configuration": ".github/workflows/main.yml"
  },
  "code_formatting": {
  "formatter": "Black",
  "linting_tool": "Pylint",
  "rules": ["PEP 8", "project-specific rules"]
  },
  "architecture": {
    "patterns": ["Modular design"],
    "principles": ["Single Responsibility", "DRY"]
    }
    },
    "project_specific": {
    "use_framework": "None",
    "styling": "Not applicable",
    "testing_framework": "pytest",
    "build_tool": "setuptools",
    "deployment": {
    "environment": "Local machine",
    "automation": "Not specified",
    "strategy": "Manual deployment"
    },
    "performance": {
    "benchmarking_tool": "Not specified",
    "performance_goals": {
    "response_time": "< 5 seconds per file",
    "throughput": "Not specified",
    "error_rate": "< 1%"
    }
    }
    },
    "context": {
      "codebase_overview": "Python-based file organization tool using AI for content analysis and classification",
      "libraries": ["watchdog", "spacy", "PyPDF2", "python-docx", "pandas", "beautifulsoup4", "transformers", "scikit-learn", "joblib", "python-dotenv", "torch", "pytest", "shutil", "logging", "pytest-mock"],
      "coding_practices": {
      "modularity": true,
      "DRY_principle": true,
      "performance_optimization": true
      }
      },
      "behavior": {
      "verbosity": {
      "level": 2,
      "range": [0, 3]
      },
      "handle_incomplete_tasks": "Provide partial solution and explain limitations",
      "ask_for_clarification": true,
      "communication_tone": "Professional and concise"
      }
      }