Skip to content

Latest commit

 

History

History
95 lines (71 loc) · 1.95 KB

File metadata and controls

95 lines (71 loc) · 1.95 KB

Contributing to SocialAPIs MCP Server

Thank you for your interest in contributing! We welcome contributions from the community.

How to Contribute

Reporting Bugs

  1. Check if the bug already exists in Issues
  2. If not, create a new issue with:
    • Clear title
    • Detailed description
    • Steps to reproduce
    • Expected vs actual behavior
    • Your environment (OS, Node version, etc.)

Suggesting Features

  1. Check if the feature is already requested
  2. Create a new issue with:
    • Clear use case
    • Expected behavior
    • Why it would be useful

Pull Requests

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/my-feature
  3. Make your changes
  4. Test thoroughly
  5. Commit with clear messages
  6. Push to your fork
  7. Open a Pull Request

Development Setup

# Clone your fork
git clone https://github.com/YOUR_USERNAME/mcp-server.git
cd mcp-server

# Install dependencies
npm install

# Test locally
node mcp-wrapper.js YOUR_API_KEY

Code Style

  • Use ES6+ features
  • Follow existing code style
  • Add comments for complex logic
  • Keep functions small and focused

Commit Messages

Format: type: description

Types:

  • feat: New feature
  • fix: Bug fix
  • docs: Documentation
  • style: Formatting
  • refactor: Code restructuring
  • test: Adding tests
  • chore: Maintenance

Examples:

feat: add Instagram support
fix: handle pagination edge case
docs: update installation guide

Testing

Before submitting:

  1. Test with your API key
  2. Verify all tools work
  3. Check for console errors
  4. Test on different platforms if possible

Code of Conduct

  • Be respectful and inclusive
  • Welcome newcomers
  • Focus on constructive feedback
  • Report unacceptable behavior

Questions?

Thank you for contributing! 🎉