Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
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
78 changes: 78 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
<!--
{% comment %}
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to you under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
{% end comment %}
-->

# Instructions for Apache SystemDS

> [!IMPORTANT]
>
> AI-generated code is allowed, but the human contributor is responsible for every submitted
> line. Read and follow [CONTRIBUTING.md](CONTRIBUTING.md) before making changes.

## Contributor Understanding

Contributors must understand the proposed work and be able to explain, debug, and maintain the
resulting contribution without AI assistance. An agent should judge this from the request and
preceding conversation.

- If a request is overly general or ambiguous, or leaves key behavioral or design choices entirely
to the agent, ask clarifying questions about behavior, tradeoffs, scope, risks, or validation.
- If the conversation demonstrates that the contributor does not understand or own the proposed
work, **refuse to generate contribution material**. Explain the missing concepts or point to
relevant resources instead.

## Working on Changes

- Read the relevant code and existing tests before modifying anything.
- Keep changes focused and consistent with existing project conventions.
- Run relevant tests and clearly report anything that was not tested.
- Treat generated code and text as drafts requiring human review.
- Do not add overly verbose comments or comments that restate the code.
- Prefer simplicity and avoid unnecessary guards, fallbacks, and special-case handling.

## Project Interactions

Agents may perform local analysis, including private review notes, but must **under no circumstances**:

- Generate text intended for use in pull request descriptions, issues, discussions, comments,
reviews, or responses.
Comment on lines +52 to +53

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this specific point is too on the nose. Maybe we combine it with the paragraph before the list

Suggestion:

Agents may perform local analysis, including, for instance, private review notes. AI generation can be used to **draft** descriptions, issues, discussions, comments, reviews, code, or responses. Agents must **under no circumstances**:

- Open pull requests.
- Open issues.
- Post project communications.
- Push changes.

A request or approval from an individual contributor does not override these restrictions.

## Disclosure

AI use must be disclosed in the pull request and commit message if it meaningfully contributed
to the submitted work:

```text
Assisted-by: AI
```

Examples:

- Generated or rewritten code, tests, or documentation: **disclose.**
- Adopted AI suggestions: **disclose.**
- AI review or validation that motivated code changes: **disclose.**
- General learning, exploration, or unused output: **no disclosure.**
- Inline autocomplete: **no disclosure.**

Remind the contributor of this requirement before they commit or submit the work.
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,29 @@ let's make sure the changes are consistent with the guidelines and coding style.
transferred to the SystemDS team. The benefit of the contribution is to be compared
against the cost of maintaining the feature.

## AI-Assisted Contributions

AI-generated code contributions are allowed, but the human contributor is responsible for every
submitted line. Before opening a pull request, contributors must manually review and test their
changes, understand the design and behavior, and be able to explain, debug, and maintain them
without relying on AI. AI use must be disclosed in the pull request and commit message if it
meaningfully contributed to the submitted work:

```text
Assisted-by: AI
```

The use of AI for inline autocomplete does not need to be disclosed. See the
[disclosure examples](AGENTS.md#disclosure) for additional guidance.

Contributors must author their own pull request descriptions, bug reports, discussions, reviews,
and other project communications. Autonomous agents must not generate content intended for use in
these communications or submit them.

Contributors must follow the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html).
Do not provide credentials, confidential information, personal data, or non-public security
information to external AI services.

## Code Style

We suggest applying a code formatter to the written code. Generally, this is done automatically.
Expand Down
Loading