Skip to content

Commit 257c652

Browse files
authored
Add AI policy (#158)
1 parent 596b3f0 commit 257c652

3 files changed

Lines changed: 41 additions & 3 deletions

File tree

.pre-commit-config.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,20 @@ repos:
1414
- id: end-of-file-fixer
1515
- id: trailing-whitespace
1616
- repo: https://github.com/psf/black
17-
rev: 25.12.0
17+
rev: 26.3.1
1818
hooks:
1919
- id: black
2020
- repo: https://github.com/PyCQA/flake8
2121
rev: 7.3.0
2222
hooks:
2323
- id: flake8
2424
- repo: https://github.com/PyCQA/isort
25-
rev: 7.0.0
25+
rev: 8.0.1
2626
hooks:
2727
- id: isort
2828
args: ["--profile", "black"]
2929
- repo: https://github.com/pre-commit/mirrors-mypy
30-
rev: v1.19.1
30+
rev: v1.20.1
3131
hooks:
3232
- id: mypy
3333
additional_dependencies: [types-requests]

AI.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# AI Coding Assistants
2+
3+
This document provides guidance for AI tools and developers using AI assistance when contributing to `spyrmsd`.
4+
5+
AI tools helping with `spyrmsd` development should follow the standard development process.
6+
7+
## Licensing and Legal Requirements
8+
9+
All contributions must comply with the `spyrmsd`'s licensing requirements:
10+
11+
* All code must be compatible with the MIT license
12+
* Use appropriate SPDX license identifiers
13+
14+
15+
## Signed-off-by and Developer Certificate of Origin
16+
17+
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:
18+
19+
* Reviewing all AI-generated code
20+
* Ensuring compliance with licensing requirements
21+
* Adding their own Signed-off-by tag to certify the DCO
22+
* Taking full responsibility for the contribution
23+
24+
## Attribution
25+
26+
When AI tools contribute to `spyrmsd` 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:
27+
28+
```
29+
Assisted-by: AGENT_NAME:MODEL_VERSION [TOOL1] [TOOL2]
30+
```
31+
32+
Where `AGENT_NAME` is the name of the AI tool or framework,
33+
`MODEL_VERSION` is the specific model version used, and
34+
`[TOOL1] [TOOL2]` are optional specialized analysis tools used.
35+
Basic development tools (git, gcc, make, editors) should not be listed.

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,9 @@ The available backends (which depend on the installed dependencies) are stored i
173173

174174
## Development
175175

176+
> [!WARNING]
177+
> Please check out our [AI policy](AI.md) for the use of AI tools in development.
178+
176179
To ensure code quality and consistency the following tools are used during development:
177180

178181
* [black](https://black.readthedocs.io/en/stable/)

0 commit comments

Comments
 (0)