Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (41 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

59 lines (41 loc) · 1.24 KB

Contributing to Comet MCP Enhanced

Thank you for your interest in contributing to Comet MCP Enhanced.

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Install dependencies with npm install
  4. Create a feature branch from main

Development Setup

# Install dependencies
npm install

# Build the project
npm run build

# Run in development mode
npm run dev

Code Standards

  • Use TypeScript strict mode
  • Follow existing code patterns and naming conventions
  • Add JSDoc comments for public APIs
  • Ensure all code compiles without errors

Pull Request Process

  1. Update documentation if you change APIs
  2. Add tests for new functionality
  3. Ensure the build passes
  4. Write a clear PR description explaining your changes
  5. Reference any related issues

Reporting Issues

When reporting issues, please include:

  • Operating system and version
  • Node.js version
  • Comet browser version
  • Steps to reproduce the issue
  • Expected vs actual behavior
  • Relevant error messages or logs

Code of Conduct

  • Be respectful and constructive
  • Focus on the technical merits of contributions
  • Help others learn and improve

License

By contributing, you agree that your contributions will be licensed under the MIT License.