Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (38 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

56 lines (38 loc) · 1.7 KB

Contributing to Ollama-MCP Bridge WebUI

Thank you for considering contributing to Ollama-MCP Bridge WebUI! This document provides guidelines and instructions for contributing.

Code of Conduct

Please be respectful and considerate of others when contributing to this project.

How Can I Contribute?

Reporting Bugs

  • Check if the bug has already been reported in the Issues section
  • Use the bug report template when creating a new issue
  • Include detailed steps to reproduce the bug
  • Include information about your environment (OS, Node.js version, etc.)

Suggesting Features

  • Check if the feature has already been requested in the Issues section
  • Use the feature request template when creating a new issue
  • Explain why this feature would be useful to most users

Pull Requests

  1. Fork the repository
  2. Create a new branch for your feature or bug fix
  3. Make your changes
  4. Run tests to ensure your changes don't break existing functionality
  5. Submit a pull request with a clear description of your changes

Development Setup

  1. Fork and clone the repository
  2. Install dependencies with npm install
  3. Create a .env file based on .env.template
  4. Build the project with npm run build
  5. Start the development server with npm run start

Coding Guidelines

  • Follow the existing code style
  • Write clear, descriptive commit messages
  • Update documentation when necessary
  • Add tests for new features

Adding New MCP Servers

To add support for a new MCP server:

  1. Install the MCP server package
  2. Add it to the configuration in a way consistent with existing MCPs
  3. Test thoroughly to ensure it works properly
  4. Document the new MCP in the README

Thank you for your contributions!