Skip to content

Instantly share code, notes, and snippets.

@ragingwind

ragingwind/CONTRIBUTING.md

Last active July 16, 2025 22:31
Show Gist options
  • Save ragingwind/0a005b83535aeaa6e7f087d41d1dabfe to your computer and use it in GitHub Desktop.
Save ragingwind/0a005b83535aeaa6e7f087d41d1dabfe to your computer and use it in GitHub Desktop.
Download ZIP
CONTRIBUTING.md template
Raw
CONTRIBUTING.md

CONTRIBUTING.md

This file provides guidance to AI code assistants when working with code in this repository. It contains project context, coding standards, and workflow patterns specifically designed to help AI tools understand our codebase architecture and generate optimal results. Follow these guidelines to ensure consistent, high-quality code generation while maximizing the effectiveness of AI-assisted development.

Table of Contents

Overview

Prerequisites

Development Environment Setup

Project Structure & Context

Task Planning and Decomposition

AI Coding Workflow

Development Workflow

Code Guidelines & Standards

Cursor Editor Configuration

Claude Code Integration

Shared Context Management

Best Practices

Common Patterns

Multi-Tool Collaboration

Version Control & Git Workflow

Testing Guidelines

Performance Optimization

Security Considerations

Documentation Standards

Troubleshooting

Tools & Extensions

Resources & References

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment