Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

72 lines (51 loc) · 1.69 KB

Contributing to MCP Sovereign SDK

Thank you for your interest in contributing to the MCP Sovereign SDK!

How to Contribute

Reporting Bugs

  1. Check if the bug has already been reported in Issues
  2. If not, create a new issue with:
    • Clear title describing the bug
    • Steps to reproduce
    • Expected behavior
    • Actual behavior
    • Environment details (Node version, OS, SDK version)

Suggesting Features

  1. Check existing Issues for similar suggestions
  2. Create a new issue with:
    • Clear title
    • Use case description
    • Proposed solution (if any)

Pull Requests

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests (npm test)
  5. Commit with clear messages (git commit -m 'Add amazing feature')
  6. Push to your fork (git push origin feature/amazing-feature)
  7. Open a Pull Request

Development Setup

# Clone your fork
git clone https://github.com/YOUR_USERNAME/mcpsovereign-sdk.git
cd mcpsovereign-sdk

# Install dependencies
npm install

# Build
npm run build

# Run tests
npm test

Code Style

  • Use TypeScript
  • Follow existing code patterns
  • Add types for all functions
  • Document public APIs

Commit Messages

  • Use present tense ("Add feature" not "Added feature")
  • Use imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Keep first line under 72 characters

Questions?

License

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