Contributing to AI Factory Operations Agent#

Contributions to AI Factory Operations Agent can report a problem, propose a feature, improve documentation, or implement an approved change.

Report An Issue#

Use the issue chooser and select the form that matches the request. Include the chart version, Kubernetes version, enabled modules, reproduction steps, and sanitized logs when reporting a bug. Never include credentials, tokens, kubeconfig contents, or other secrets.

Security vulnerabilities must follow SECURITY.md instead of the public issue tracker.

Propose A Change#

Open an issue before substantial implementation work so maintainers can confirm scope and design. Small documentation corrections may proceed directly to a pull request.

Code Contributions#

Pull request scope#

Each pull request must contain one independently reviewable component: a single feature, bug fix, refactor, or documentation change. Split work involving multiple features or separable components into individual pull requests, even when they support the same larger goal. Separate commits within one pull request do not replace separate pull requests.

Keep the implementation, tests, and documentation needed for that component together. If a component depends on another pull request, link the dependency and describe the review and merge order. Maintainers will ask for bundled changes to be split before review.

  1. Fork the repository and create a focused branch from main.

  2. Keep changes minimal and include documentation for user-visible behavior.

  3. Validate the Helm chart:

    helm dependency build ./helm/mosaic-stack
    helm lint ./helm/mosaic-stack
    helm template mosaic ./helm/mosaic-stack >/dev/null
    
  4. Open a pull request using the repository template.

  5. Address review feedback and ensure required status checks pass.

When adding a heading or installation option to docs/installation.md, update docs/installation_builder.md and docs/_static/install-builder.mjs in the same change. Keep the builder’s options, generated Helm flags, prerequisites, and guide links aligned with the installation guide. For sections that do not map to a selectable option, include the relevant guidance or link in the builder page. Validate with node --test tests/docs/*.test.mjs and uv run --project docs --locked sphinx-build -W --keep-going -b html -c docs . docs/_build/html, then inspect the rendered builder.

Developer Certificate Of Origin#

External contributions require agreement to the Developer Certificate of Origin 1.1. Every commit must include a Signed-off-by line. Add it automatically with the -s option:

git commit -s -m "Describe the change"

The sign-off adds a Signed-off-by: Name <email@example.com> line and certifies the contribution under the DCO. Pull requests containing unsigned commits cannot be merged.

Full Text Of The DCO#

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

NVIDIA maintainers also apply the project IP review process before accepting or distributing third-party contributions.

By participating, you agree to follow the Code of Conduct.