Contributing to Spec2Cloud Toolkit

November 7, 2025 · View on GitHub

Thank you for your interest in contributing to Spec2Cloud Toolkit! This document provides guidelines for contributing to the project.

Getting Started

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/your-username/spec2cloud-toolkit.git
  3. Install dependencies: npm install
  4. Make your changes
  5. Test your changes
  6. Submit a pull request

Development Setup

  1. Open the project in VS Code
  2. Press F5 to launch the extension in a new Extension Development Host window
  3. Make changes to the code
  4. Reload the Extension Development Host window to test changes

Code Style

  • Use TypeScript for all code
  • Follow the existing code style
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Format code using VS Code's built-in formatter

Testing

Before submitting a pull request:

  1. Test all features manually
  2. Ensure the extension compiles without errors: npm run compile
  3. Check for linting errors: npm run lint

Pull Request Process

  1. Update the README.md with details of changes if applicable
  2. Update the CHANGELOG.md with a description of your changes
  3. Ensure your code compiles and runs without errors
  4. Submit your pull request with a clear description of the changes

Reporting Bugs

When reporting bugs, please include:

  • VS Code version
  • Extension version
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Screenshots if applicable

Feature Requests

We welcome feature requests! Please provide:

  • Clear description of the feature
  • Use case for the feature
  • Any relevant examples or mockups

Code of Conduct

Please be respectful and constructive in all interactions with the community.

Thank you for contributing! 🚀