Prompt file imported from ideaSquared/pairflix (.github/prompts/architecture-standards.prompt.md). Copyright stays with the author.

Architecture Standards

Name: architecture-standards
Author: ideaSquared

API Standards

REST Design

Use proper HTTP methods (GET, POST, PUT, PATCH, DELETE)
Implement appropriate status codes (200, 201, 204, 400, 401, 403, 404, 500)
Use plural nouns for resource names
Implement versioning (e.g., /api/v1/resources)
Keep endpoints consistent and predictable

Documentation

Use OpenAPI/Swagger for API documentation
Include examples for all endpoints
Document error responses
Provide authentication information
Keep documentation updated with changes

Security

Implement rate limiting to prevent abuse
Configure proper CORS policies
Require authentication for protected endpoints
Implement proper authorization for resources
Validate and sanitize all inputs

State Management

Frontend Patterns

Use React Context for global UI state
Consider Redux or Zustand for complex state
Use React Query or SWR for server state
Keep component state local when possible
Implement proper state immutability

Data Fetching

Implement retry logic for failed requests
Set up cache invalidation strategies
Use prefetching for improved UX
Handle loading states consistently
Implement optimistic updates where appropriate

Error Boundaries

Implement at the route level
Create fallback UIs for failed components
Set up error reporting to monitoring systems
Recover gracefully when possible
Preserve user input during errors

Error Handling

Error Classification

API errors (network, server, validation)
Authentication and authorization errors
Network connectivity errors
Runtime errors (null references, type errors)
Business logic errors

Implementation

Create custom error classes for different error types
Implement global error handlers
Set up recovery strategies
Handle expected errors gracefully
Provide clear feedback to users

Logging

Use structured logging format
Include contextual information
Set appropriate log levels
Redact sensitive information
Ensure searchability of logs

# Architecture Standards ## API Standards ### REST Design - Use proper HTTP methods (GET, POST, PUT, PATCH, DELETE) - Implement appropriate status codes (200, 201, 204, 400, 401, 403, 404, 500) - Use plural nouns for resource names - Implement versioning (e.g., /api/v1/resources) - Keep endpoints consistent and predictable ### Documentation - Use OpenAPI/Swagger for API documentation - Include examples for all endpoints - Document error responses - Provide authentication information - Keep documentation updated with changes ### Security - Implement rate limiting to prevent abuse - Configure proper CORS policies - Require authentication for protected endpoints - Implement proper authorization for resources - Validate and sanitize all inputs ## State Management ### Frontend Patterns - Use React Context for global UI state - Consider Redux or Zustand for complex state - Use React Query or SWR for server state - Keep component state local when possible - Implement proper state immutability ### Data Fetching - Implement retry logic for failed requests - Set up cache invalidation strategies - Use prefetching for improved UX - Handle loading states consistently - Implement optimistic updates where appropriate ### Error Boundaries - Implement at the route level - Create fallback UIs for failed components - Set up error reporting to monitoring systems - Recover gracefully when possible - Preserve user input during errors ## Error Handling ### Error Classification - API errors (network, server, validation) - Authentication and authorization errors - Network connectivity errors - Runtime errors (null references, type errors) - Business logic errors ### Implementation - Create custom error classes for different error types - Implement global error handlers - Set up recovery strategies - Handle expected errors gracefully - Provide clear feedback to users ### Logging - Use structured logging format - Include contextual information - Set appropriate log levels - Redact sensitive information - Ensure searchability of logs

{ "prompt": "# Architecture Standards\n\n## API Standards\n\n### REST Design\n\n- Use proper HTTP methods (GET, POST, PUT, PATCH, DELETE)\n- Implement appropriate status codes (200, 201, 204, 400, 401, 403, 404, 500)\n- Use plural nouns for resource names\n- Implement versioning (e.g., /api/v1/resources)\n- Keep endpoints consistent and predictable\n\n### Documentation\n\n- Use OpenAPI/Swagger for API documentation\n- Include examples for all endpoints\n- Document error responses\n- Provide authentication information\n- Keep documentation updated with changes\n\n### Security\n\n- Implement rate limiting to prevent abuse\n- Configure proper CORS policies\n- Require authentication for protected endpoints\n- Implement proper authorization for resources\n- Validate and sanitize all inputs\n\n## State Management\n\n### Frontend Patterns\n\n- Use React Context for global UI state\n- Consider Redux or Zustand for complex state\n- Use React Query or SWR for server state\n- Keep component state local when possible\n- Implement proper state immutability\n\n### Data Fetching\n\n- Implement retry logic for failed requests\n- Set up cache invalidation strategies\n- Use prefetching for improved UX\n- Handle loading states consistently\n- Implement optimistic updates where appropriate\n\n### Error Boundaries\n\n- Implement at the route level\n- Create fallback UIs for failed components\n- Set up error reporting to monitoring systems\n- Recover gracefully when possible\n- Preserve user input during errors\n\n## Error Handling\n\n### Error Classification\n\n- API errors (network, server, validation)\n- Authentication and authorization errors\n- Network connectivity errors\n- Runtime errors (null references, type errors)\n- Business logic errors\n\n### Implementation\n\n- Create custom error classes for different error types\n- Implement global error handlers\n- Set up recovery strategies\n- Handle expected errors gracefully\n- Provide clear feedback to users\n\n### Logging\n\n- Use structured logging format\n- Include contextual information\n- Set appropriate log levels\n- Redact sensitive information\n- Ensure searchability of logs", "variables": [], "notes": "Architecture standards for APIs, state management, and error handling Mode: agent.", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/ideaSquared/pairflix", "path": ".github/prompts/architecture-standards.prompt.md", "ref": "256c82bb3b8fd10add3fac084469021b84915c1c", "url": "https://github.com/ideaSquared/pairflix/blob/256c82bb3b8fd10add3fac084469021b84915c1c/.github/prompts/architecture-standards.prompt.md", "key": "ideaSquared/pairflix/.github/prompts/architecture-standards.prompt.md" } } }

architecture-standards

About