Skip to content

Latest commit

 

History

History
88 lines (62 loc) · 2.54 KB

CONTRIBUTING.md

File metadata and controls

88 lines (62 loc) · 2.54 KB

Contributing to Composer Web Extension

First off, thank you for considering contributing to Composer Web Extension! It's people like you that make this extension such a great tool.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the existing issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible:

  • Use a clear and descriptive title
  • Describe the exact steps which reproduce the problem
  • Provide specific examples to demonstrate the steps
  • Describe the behavior you observed after following the steps
  • Explain which behavior you expected to see instead and why
  • Include screenshots if possible
  • Include your environment details:
    • OS version
    • Chrome/Chromium version
    • Cursor version
    • Node.js version

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When creating an enhancement suggestion, please include:

  • A clear and descriptive title
  • A detailed description of the proposed functionality
  • Explain why this enhancement would be useful
  • List any similar features in other extensions if you know of any
  • Include mockups or examples if applicable

Pull Requests

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Include screenshots and animated GIFs in your pull request whenever possible
  • Follow our coding conventions and style guide
  • Document new code
  • End all files with a newline

Development Process

  1. Fork the repo and create your branch from main
  2. Run npm install to install dependencies
  3. Make your changes
  4. Add tests if applicable
  5. Run npm test to ensure nothing is broken
  6. Update documentation if needed
  7. Create your pull request

Local Development Setup

# Clone your fork
git clone https://github.com/your-username/composer-web.git

# Install dependencies
npm install

# Start development
npm run watch

# Run tests
npm test

Coding Style

  • Use 2 spaces for indentation
  • Use semicolons
  • Follow TypeScript best practices
  • Write meaningful commit messages following Conventional Commits

Community

  • Join our discussions in GitHub issues
  • Follow our updates

Questions?

Feel free to open an issue with your question or reach out to the maintainers.

Thank you for contributing! 🎉