Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (31 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

51 lines (31 loc) · 1.86 KB

Contributing to OSP

Thank you for your interest in the Open Service Protocol. This project is in its early stages, and contributions are welcome.

How to Contribute

Share an Example

The most valuable contribution right now is real-world osp.md files. If you create one for your business or industry, submit it as a pull request to the examples/ directory.

Report Issues

If something in the spec is unclear, inconsistent, or impractical, open an issue. Describe what you tried to do, what you expected, and what didn't work.

Propose Changes

For changes to the specification:

  1. Open an issue first to discuss the change
  2. Reference the specific section of the spec
  3. Explain the problem the change solves
  4. If possible, include an example showing the before/after

For code contributions (tools, validators, reference implementations):

  1. Fork the repository
  2. Create a branch from main
  3. Make your changes
  4. Run existing tests if applicable
  5. Submit a pull request

Implement the Spec

If you build something that uses OSP — a validator, a client library, an integration — let us know. We maintain a list of implementations in the wiki.

What We're Looking For

Right now, the project needs:

  • Feedback on the spec — Is the osp.md format practical? What's missing?
  • Real-world examples — osp.md files for different industries
  • Edge cases — Services that don't fit the current format
  • Integrations — How OSP works with MCP, llms.txt, and existing tools

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you agree to uphold this standard.

License

By contributing, you agree that your contributions will be licensed under the same terms as the project: CC-BY-4.0 for specification text, Apache 2.0 for code. See NOTICE for details.