Skip to content

Files

Latest commit

 

History

History
67 lines (38 loc) · 3.39 KB

CONTRIBUTING.md

File metadata and controls

67 lines (38 loc) · 3.39 KB

Here’s a summarized and rephrased version of your contribution guide:

Contributing to rust-mcp-schema

🎉 Thank you for your interest in improving rust-mcp-schema! Every contribution, big or small, is valuable and appreciated.

Code of Conduct

We follow the Rust Code of Conduct. Please be respectful and inclusive when contributing.

How to Contribute

Participating in Tests, Documentation, and Examples

We highly encourage contributors to improve test coverage, enhance documentation, and introduce new examples to ensure the reliability and usability of the project. If you notice untested code paths, missing documentation, or areas where examples could help, consider adding tests, clarifying explanations, or providing real-world usage examples. Every improvement helps make the project more robust, well-documented, and accessible to others!

Participating in Issues

You can contribute in three key ways:

  1. Report Issues – If you find a bug or have an idea, open an issue for discussion.
  2. Help Triage – Provide details, test cases, or suggestions to clarify issues.
  3. Resolve Issues – Investigate problems and submit fixes via Pull Requests (PRs).

Anyone can participate at any stage, whether it's discussing, triaging, or reviewing PRs.

Filing a Bug Report

When reporting a bug, use the provided issue template and fill in as many details as possible. Don’t worry if you can’t answer everything—just provide what you can.

Fixing Issues

Most issues are resolved through a Pull Request. PRs go through a review process to ensure quality and correctness.

❗Caution

The mcp_schema.rs file(s) and certain parts of schema_utils are automatically generated. The code responsible for generating these files is not part of this repository at this time. As a result, we do not accept pull requests for these sections. If you discover a bug or have suggestions that involve changing the autogenerated code, please open an issue and share your proposed modifications. We'll update the schema generator as needed, and your changes will be included in a future release.

🤜 Pull requests are welcome for non-autogenerated parts of schema_utils.

Pull Requests (PRs)

We welcome PRs! Before submitting, please:

  1. Discuss major changes – Open an issue before adding a new feature and opening a PR.
  2. Create a feature branch – Fork the repo and branch from main.
  3. Write tests – If your change affects functionality, add relevant tests.
  4. Update documentation – If you modify APIs, update the docs.
  5. Run tests – Make sure all tests succeed for every schema version.

Commit Best Practices

  • Logically separate commits – Keep changes atomic and easy to review.
  • Maintain a bisect-able history – Each commit should compile and pass all tests to enable easy debugging with git bisect in case of regression.

License

By contributing to rust-mcp-schema, you acknowledge and agree that your contributions will be licensed under the terms specified in the LICENSE file located in the root directory of this repository.

We appreciate your contributions and look forward to working with you! 🚀