Skip to content

Latest commit

 

History

History
54 lines (32 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

54 lines (32 loc) · 1.89 KB

Contributing to MCPSharp

Introduction

Thank you for your interest in contributing to MCPSharp! This document outlines the process for contributing to the project.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct.

How Can I Contribute?

Reporting Bugs

If you find a bug, please open an issue and include detailed steps to reproduce the problem. Ensure the issue has not already been reported by searching the issues list.

Suggesting Enhancements

We welcome suggestions for new features or improvements. Please submit an issue with:

  • A clear description of the enhancement.
  • Any relevant examples or references.

Pull Requests

We welcome pull requests! To ensure a smooth process, please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Write clear and concise commit messages.
  4. Ensure your code follows the project's coding standards.
  5. Write tests for your changes.
  6. Open a pull request and provide a detailed description of your changes.

Coding Standards

  • Follow the C# Coding Conventions.
  • Use meaningful variable and function names.
  • Include comments and documentation where necessary.

Tests

Ensure that you write tests for your contributions. Run all tests to verify your changes do not break existing functionality.

Documentation

If your changes affect the project's documentation, please update it accordingly. This includes the README, API documentation, and any other relevant files.

Acknowledgements

We appreciate all contributions and thank you for your help in improving MCPSharp!

Questions

If you have any questions or need further assistance, please open an issue or contact the maintainers.