Skip to content

Latest commit

 

History

History
61 lines (45 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

61 lines (45 loc) · 1.98 KB

Contributing to MCP Mongo Server

Thank you for your interest in contributing to the MCP Mongo Server project! 🎉
We appreciate all types of contributions, from bug reports and feature requests to documentation and code improvements.

How to Contribute

Reporting Bugs

If you discover a bug, please open an issue in the Issues tab.
Make sure to include:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Expected vs. actual behavior.
  • Relevant logs or screenshots (if applicable).

Suggesting Features

Got a great idea? We’d love to hear it!

  • Open an issue and label it as a "Feature Request."
  • Clearly explain the feature, its purpose, and its benefits.

Submitting Code Changes

We welcome pull requests for code, documentation, and tests.

Steps:

  1. Fork the repository using the "Fork" button on this page.
  2. Create a branch with a descriptive name, for example:
    git checkout -b feature/your-feature-name
  3. Make your changes, ensuring they align with the project’s goals and standards.
  4. Test your changes to verify they work as intended.
  5. Commit your changes with a clear and descriptive message, for example:
    git commit -m "Add feature: your-feature-name"
  6. Push your changes to your forked repository:
    git push origin feature/your-feature-name
  7. Open a pull request to the main branch in this repository, including a detailed description of your changes.

Guidelines

To maintain quality, please:

  • Write clean, maintainable, and well-documented code.
  • Follow the existing coding style.
  • Include tests for new functionality where applicable.
  • Be respectful and constructive in discussions.

Acknowledgements

We are grateful for all contributions to this project!

Questions or Feedback?

If you need help or want to share feedback:

  • Open an issue in this repository.
  • Contact the maintainers.

Thank you for helping improve MCP Mongo Server! 💖