Contributing to MCP Filesystem

Thank you for your interest in contributing to this project!

Getting Started

Fork the repository
Clone your fork: git clone git@github.com:your-username/mcp-filesystem.git
Create a new branch: git checkout -b feature-name
Make your changes
Run quality checks: make check
Commit your changes: git commit -m "Description of changes"
Push to your fork: git push origin feature-name
Open a Pull Request

Development Setup

# Install dependencies and set up environment
make setup

# Run all quality checks
make check

Code Quality Standards

All code must be typed with proper type hints
Tests must be included for new features
Documentation must be updated when necessary
All quality checks must pass (make check)

Pull Request Process

Update the README.md with details of significant changes
Update the CHANGELOG.md following the existing format
The PR will be merged once you have the sign-off of at least one maintainer

Questions?

Feel free to open an issue for any questions or concerns.