realtimecursor/CONTRIBUTING.md

Real-time collaboration system with cursor tracking and approval workflow

# Contributing to RealtimeCursor

Thank you for your interest in contributing to RealtimeCursor! This document provides guidelines and instructions for contributing.

## Code of Conduct

Please be respectful and considerate of others when contributing to this project.

## How to Contribute

### Reporting Bugs

If you find a bug, please create an issue with:

1. A clear title and description
2. Steps to reproduce the bug
3. Expected behavior
4. Actual behavior
5. Screenshots if applicable
6. Your environment (browser, OS, etc.)

### Suggesting Features

Feature suggestions are welcome! Please create an issue with:

1. A clear title and description
2. Why this feature would be useful
3. How it should work
4. Any implementation ideas you have

### Pull Requests

1. Fork the repository
2. Create a new branch: `git checkout -b feature/your-feature-name`
3. Make your changes
4. Run tests: `npm test`
5. Commit your changes: `git commit -m 'Add some feature'`
6. Push to the branch: `git push origin feature/your-feature-name`
7. Submit a pull request

### Coding Standards

- Follow the existing code style
- Write clear, readable code
- Add comments for complex logic
- Write tests for new features

## Development Setup

1. Clone the repository:
   ```bash
   git clone https://github.com/sourabhpunase/realtimecursor.git
   cd realtimecursor
   ```

2. Install dependencies:
   ```bash
   npm install
   ```

3. Start the development server:
   ```bash
   npm run dev
   ```

4. Build the SDK:
   ```bash
   cd sdk
   npm run build:dev
   ```

## Project Structure

- `/api` - Backend server code
- `/sdk` - SDK source code
- `/realtime` - Frontend React app
- `/examples` - Example implementations
- `/docs` - Documentation

## Testing

Run tests with:

```bash
npm test
```

## Documentation

Please update documentation when adding or changing features.

## License

By contributing, you agree that your contributions will be licensed under the project's [MIT License](LICENSE).