Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
126 lines (83 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

126 lines (83 loc) · 3.13 KB

Contributing to Firecrawl MCP Server

We love your input! We want to make contributing to the Firecrawl MCP server as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Development Process

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

  1. Fork the repo and create your branch from main
  2. If you've added code that should be tested, add tests
  3. If you've changed APIs, update the documentation
  4. Ensure the test suite passes
  5. Make sure your code lints
  6. Issue that pull request!

Local Development Setup

  1. Install dependencies:

    npm install

  2. Set up environment variables:

    export FIRECRAWL_API_KEY=your-api-key

  3. Start development server:

    npm run dev

Using Docker for Development

  1. Start the development container:

    docker-compose up mcp-server-dev

  2. Run tests in container:

    docker-compose up mcp-server-test

Testing

We use Jest for testing. Run the test suite with:

npm test

Make sure to:

  • Write tests for new features
  • Maintain test coverage above 80%
  • Use meaningful test descriptions

Code Style

We use ESLint and Prettier to maintain code quality. Before committing:

  1. Run linter:

    npm run lint

  2. Format code:

    npm run format

Documentation

  • Keep README.md updated
  • Document all new tools and configuration options
  • Update API documentation for changes
  • Include examples for new features

Pull Request Process

  1. Update the README.md with details of changes to the interface
  2. Update the API documentation if endpoints or tools change
  3. Update the version numbers following SemVer
  4. The PR will be merged once you have the sign-off of two other developers

Any Contributions You Make Will Be Under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report Bugs Using GitHub's Issue Tracker

Report a bug by opening a new issue; it's that easy!

Write Bug Reports With Detail, Background, and Sample Code

Great Bug Reports tend to have:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

License

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

References

This document was adapted from the open-source contribution guidelines for Facebook's Draft.