Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
89 lines (61 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

89 lines (61 loc) · 2.53 KB

Contributing to Claude Code VSCode Extension

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Development Process

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using GitHub's issue tracker

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

Use a Consistent Coding Style

  • 2 spaces for indentation rather than tabs
  • Run npm run lint to check code style

Development Setup

  1. Clone the repository:

    git clone https://github.com/codeflow-studio/claude-code-chat.git
cd claude-code-chat

  2. Install dependencies:

    npm install

  3. Start development:

    npm run watch

  4. Open VSCode and press F5 to launch a new VSCode window with the extension loaded.

Testing

Run the test suite:

npm test

Building

Build the extension:

npm run build

This creates a .vsix file that can be installed in VSCode.

License

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

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft.