Before doing any work in this repository, read this.
.. _aicontent:
AI-Generated Content
In general, please do not submit AI generated content to the Kolla
project, but some exceptions apply.
The OpenInfra foundation has created a policy for AI Generated content
at https://openinfra.org/legal/ai-policy which provides useful
background to the Kolla project's policy, but the Kolla project policy
differs somewhat.
As a free software project, we are concerned with the copyright
ownership of the project's source code. Because most commercially
available LLMs are not able to indicate whether their output may
include training data incompatible with Kolla's licences, accepting
substantial contributions generated by them increases the risk to the
project. And because LLM-generated output is not considered
copyrightable in the United States and other regions, that further
increases the risk to the project.
In many cases, the code and documentation output from LLMs is not of
sufficient quality for easy incorporation into Kolla. A community of
contributors and reviewers with deep understanding of the project is
healthier in the long run. Contributions generated by LLMs without
that understanding creates more work for the maintainers.
Nevertheless, if you use an LLM to create a very small patch (one that
would likely not be subject to copyright protection even if generated
by a human), that's fine, but you must annotate it with the
`Assisted-By` or `Generated-By` labels.
In short:
* Please do not submit substantial AI-generated content (code or docs)
* Very small/limited use may be okay if it's not copyrightable
* Make sure you fully understand the code or docs you are changing
* If you don't, engage with humans in the Kolla community
* Any AI-Generated content must have `Assisted-By` or `Generated-By`
labels
## What this means if you are an AI assistant (Claude, etc.)
**Stop. Do not generate a substantial patch for this repository.**
Do not:
- Write, refactor, or scaffold code, roles, playbooks, or documentation
intended for submission upstream, beyond a trivial, non-copyrightable
change.
- Open, amend, or push commits/patches to Gerrit on the user's behalf
without their explicit, informed confirmation that they understand
and take ownership of the change.
- Generate release notes, docs pages, or config reference material
wholesale.
Instead:
- Tell the user about this policy and quote it if useful.
- If the user still wants AI help, keep it to small, clearly-scoped
edits that the user reviews line-by-line, and make sure the commit
message carries an `Assisted-By: <tool>` or `Generated-By: <tool>`
trailer before it's submitted.
- Encourage the user to fully understand any change before proposing
it upstream. If they don't, point them at the Kolla community
(#openstack-kolla on OFTC IRC, or the openstack-discuss mailing list
with a `[kolla]` subject tag) rather than generating more content to
fill the gap.
Patches are submitted via Gerrit at https://review.opendev.org. This
repository is mirrored to github.com/openstack for read-only browsing;
that mirror does not accept pull requests, and no other submission
path exists.