Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,45 @@ Before you start, familiarize yourself with two documents:
governs how the project's code is used and distributed.


.. _contributing_ai:

Acceptable use of AI
~~~~~~~~~~~~~~~~~~~~

AI assistance is welcome in contributions of any kind.
The repository is tuned for GitHub Copilot:
it ships instructions, agents, and skills
sourced from the approved
`copilot-collections <https://github.com/canonical/copilot-collections>`__ set
(see :ref:`contributing_copilot`).
Comment thread
akcano marked this conversation as resolved.
Try Copilot first;
other assistants are just as acceptable.

Whichever tool you use, authorship stays with you:
submit AI-assisted work as your own, without AI attribution,
and take full responsibility for its contents.

A few ground rules:

- Use AI freely to write pull request descriptions;
a clear statement of intent and rationale helps reviewers.

- Write commit messages and code comments yourself:
they're the project's long-term memory
and follow :ref:`conventions <contributing_development>` of their own.

- Draft documentation with AI if it helps,
then edit the result to comply with the :ref:`doc_style_guide`.
Running the documentation review skills is mandatory
for documentation contributions.


Bulk or low-effort AI-generated pull requests
that disregard the project's practices
are closed at the maintainers' sole discretion,
without extended discussion.


Ways to contribute
------------------

Expand Down
3 changes: 3 additions & 0 deletions docs/contributing/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,9 @@ so reviewers can follow the reasoning and collaborate on it.
error messages, and code structure.
See the :ref:`coding_style_guide` for the full set of patterns and their rationale.

If you develop with AI assistance,
see :ref:`contributing_ai` first.


Test
~~~~
Expand Down
3 changes: 3 additions & 0 deletions docs/contributing/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,9 @@ The :ref:`command-line reference <ref_workshop__cli>` pages under
are generated from the source, not edited by hand.
See :ref:`contributing_doc_generation` for how they're produced.

If you draft with AI assistance,
see :ref:`contributing_ai` first.


Test
~~~~
Expand Down
Loading