Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (45 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

57 lines (45 loc) · 1.86 KB
Raw

Contributing to CodeStory AI

Thank you for your interest in contributing to CodeStory AI! 🚀

We welcome contributions from everyone. By participating in this project, you agree to abide by the Code of Conduct.

How to Contribute

1. Reporting Bugs

  • Check the Issues tab to ensure the bug hasn't been reported.
  • Open a new issue with a clear title and description.
  • Include steps to reproduce, expected behavior, and screenshots if applicable.

2. Suggesting Features

  • Open a new issue using the "Feature Request" template.
  • Explain why the feature is needed and how it improves the extension.

3. Pull Requests (PRs)

  1. Fork the repository.
  2. Clone your fork locally: 
    git clone https://github.com/YOUR_USERNAME/CodeStory-AI.git
  3. Create a branch for your feature/fix: 
    git checkout -b feature/amazing-feature
  4. Install dependencies: 
    npm install
  5. Make your changes.
  6. Test your changes:
    • Run npm run compile.
    • Press F5 to launch the Extension Development Host and verify functionality.
  7. Commit your changes with a descriptive message.
  8. Push to your fork: 
    git push origin feature/amazing-feature
  9. Open a Pull Request against the main branch of the original repository.

Development Setup

  • Node.js: Required (v18+ recommended).
  • VS Code: Recommended editor.
  • TypeScript: This project is written in TypeScript.

Style Guide

  • Use TypeScript for all logic.
  • Follow the existing code style (indentation, naming conventions).
  • Ensure all linting checks pass (npm run lint).

License

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