CONTRIBUTING.md

Contributing to Mindseye2

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

Getting Started

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request

Development Process

1. Choose an issue to work on
2. Comment on the issue to let others know you're working on it
3. Create a feature branch with a descriptive name
4. Make your changes
5. Write or update tests
6. Update documentation
7. Submit a pull request

Pull Request Process

1. Update the README.md with details of changes if needed
2. Update the documentation if you're changing functionality
3. Add tests for new features
4. Ensure the test suite passes
5. Get a code review from maintainers

Code Style

• Use consistent naming conventions
• Write meaningful commit messages
• Follow the existing code structure
• Add comments for complex logic
• Use TypeScript for new files

Testing

• Write unit tests for new features
• Ensure existing tests pass
• Add integration tests when needed
• Test edge cases

Documentation

• Update API documentation for new endpoints
• Add JSDoc comments for new functions
• Update setup instructions if needed
• Add examples for new features