Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (44 loc) · 1.13 KB

CONTRIBUTING.md

File metadata and controls

59 lines (44 loc) · 1.13 KB

Contributing to PubChem-MCP

We welcome contributions to PubChem-MCP! This document provides guidelines and instructions for contributing.

Development Setup

  1. Fork the repository
  2. Clone your fork:
git clone https://github.com/YOUR-USERNAME/PubChem-MCP.git
cd PubChem-MCP
  1. Set up the development environment:
# Create a virtual environment using uv
uv venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install development dependencies
pip install -e ".[dev]"

Making Changes

  1. Create a new branch for your changes:
git checkout -b feature/your-feature-name
  1. Make your changes and add tests if applicable
  2. Run tests to ensure everything works:
pytest
  1. Format your code:
black .
isort .

Submitting Changes

  1. Push your changes to your fork:
git push origin feature/your-feature-name
  1. Open a pull request on the main repository

Code Guidelines

  • Follow PEP 8 style guidelines
  • Include docstrings for all functions and classes
  • Add appropriate type hints
  • Write tests for new functionality

Thank you for your contributions!