Skip to content

AiCodingAssistants.md

Latest commit

 

History

History
62 lines (39 loc) · 2.56 KB

AiCodingAssistants.md

File metadata and controls

62 lines (39 loc) · 2.56 KB

AI Coding Assistants

This document provides guidance for AI tools and developers using AI assistance when contributing to DeepCausality.

Conventions

All contributors are asked to adhere to the project's conventions laid out in the following documents:

Development Process

Regardless of what tools are used, please adhere to the following standard development process during your contribution.

  1. Propose a change or patch as a GitHub issue. Feel free to discuss the issue in the community Discord or open a GitHub discussion.
  2. Break larger changes into multiple issues as appropriate to structure the work in a way that it can be reviewed.
  3. Please ensure that after completing your work, the entire code base builds, all tests pass, and neither Clippy nor Rustfmt reports any issues on the latest stable Rust toolchain. If you added new tests, make sure the Bazel tests still execute without errors. If they do not, ensure that the required test dependencies are declared in Bazel.
  4. When you file a PR, please provide a concise summary of the change set and a link to the related issue. Also, please mention any preceding discussion.
  5. Test coverage is expected to stay at the preceding level. If not, please close gaps in the test coverage. The code review can only complete when all PR checks, including test coverage, are green.

Licensing and Legal Requirements

All contributions must comply with the DeepCausality licensing requirements:

  • All code must be compatible with the MIT License
  • Use appropriate SPDX license identifiers in all files: SPDX-License-Identifier: MIT

Signed-off-by and Developer Certificate of Origin

AI agents MUST NOT add Signed-off-by tags. Only humans can legally certify the Developer Certificate of Origin (DCO). The human submitter is responsible for:

  • Reviewing all AI-generated code
  • Ensuring compliance with licensing requirements
  • Adding their own Signed-off-by tag to certify the DCO
  • Taking full responsibility for the contribution

AI Attribution

When AI tools contribute to DeepCausality development, proper attribution helps track the evolving role of AI in the development process.

Contributions should include an Assisted-by tag in the following format:

Co-Authored-By: AGENT_NAME MODEL VERSION

Where:

  • AGENT_NAME is the name of the AI tool or framework
  • MODELN is the specific model
  • VERSION is the specific version used

Example:

Co-Authored-By: Claude Opus 4.8