Skip to main content

Contributing

We welcome contributions to the AiHint standard. Whether you're fixing a typo, improving documentation, or proposing changes to the specification, here's how to get involved.

Ways to Contribute​

  • Report issues — Found a bug or have a suggestion? Open an issue on GitHub.
  • Improve documentation — Fix errors, clarify explanations, or add examples.
  • Propose spec changes — Suggest modifications to the protocol via a GitHub issue for discussion before opening a pull request.
  • Review pull requests — Help review and test proposed changes.

Getting Started​

  1. Fork the repository

    git clone https://github.com/Ai-Hint/aihint-standard.git
    cd aihint-standard

  2. Create a branch

    git checkout -b your-feature-branch

  3. Make your changes

  4. Test the documentation locally

    cd website
    npm install
    npm start

    This starts a local dev server at http://localhost:3000.

  5. Submit a pull request

    Push your branch and open a pull request against main. Describe what you changed and why.

Documentation Changes​

The documentation source lives in website/docs/. It's built with Docusaurus and uses Markdown.

To preview changes locally:

cd website
npm start

Specification Changes​

Changes to the AiHint protocol specification should be discussed in a GitHub issue before opening a pull request. The specification files are:

  • specs/aihint-global.md — Human-readable specification
  • schema/aihint-global.schema.json — JSON Schema

Code of Conduct​

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

Reporting Security Issues​

If you discover a security vulnerability, please report it responsibly. Do not open a public issue. Instead:

We will acknowledge your report within 48 hours and work to address it promptly.

License​

By contributing, you agree that your contributions will be licensed under the MIT License.