Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
93 lines (63 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

93 lines (63 loc) · 2.3 KB

Contributing to Web Scout MCP Server

Thank you for considering contributing to the Web Scout MCP Server! This document provides guidelines and instructions for contributing to this project.

Code of Conduct

Please be respectful and considerate of others when contributing to this project. We aim to foster an inclusive and welcoming community.

How to Contribute

Reporting Bugs

If you find a bug, please create an issue on GitHub with the following information:

  • A clear, descriptive title
  • A detailed description of the issue
  • Steps to reproduce the bug
  • Expected behavior
  • Actual behavior
  • Any relevant logs or error messages
  • Your environment (Node.js version, OS, etc.)

Suggesting Enhancements

If you have an idea for an enhancement, please create an issue on GitHub with the following information:

  • A clear, descriptive title
  • A detailed description of the enhancement
  • Any relevant examples or use cases
  • Any potential implementation details you can think of

Pull Requests

  1. Fork the repository
  2. Create a new branch for your changes
  3. Make your changes
  4. Run tests to ensure your changes don't break existing functionality
  5. Submit a pull request

Pull Request Guidelines

  • Follow the existing code style
  • Include tests for new functionality
  • Update documentation as needed
  • Keep pull requests focused on a single change
  • Link to any relevant issues

Development Setup

# Clone the repository
git clone https://github.com/pinkpixel-dev/web-scout-mcp.git
cd web-scout-mcp

# Install dependencies
npm install

# Build
npm run build

# Run
npm start

Code Style

  • Use TypeScript for all new code
  • Follow the existing code style in the project
  • Use meaningful variable and function names
  • Add comments for complex logic
  • Use async/await for asynchronous code

Testing

  • Write tests for new functionality
  • Ensure all tests pass before submitting a pull request
  • Run tests with npm test

Documentation

  • Update documentation for any changes to the API or functionality
  • Keep the README.md up to date
  • Add JSDoc comments to functions and classes

License

By contributing to this project, you agree that your contributions will be licensed under the project's Apache 2.0 license.

Thank you for your contributions!

✨ Made with ❤️ by Pink Pixel ✨