Skip to content

Commit 3fb0655

Browse files
committed
format and reuse compliance
1 parent 840fa35 commit 3fb0655

3 files changed

Lines changed: 35 additions & 1 deletion

File tree

.formatter.exs

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,18 @@
33
# SPDX-License-Identifier: MIT
44

55
# Used by "mix format"
6-
locals_without_parens = []
6+
locals_without_parens = [
7+
tool: 3,
8+
tool: 4
9+
]
710

811
[
912
plugins: [Spark.Formatter],
1013
inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"],
1114
import_deps: [
1215
:diffo,
1316
:ash,
17+
:ash_ai,
1418
:ash_state_machine,
1519
:ash_neo4j,
1620
:ash_jason,

AGENTS.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
<!--
2+
SPDX-FileCopyrightText: 2025 diffo_example contributors <https://github.com/diffo-dev/diffo_example/graphs.contributors>
3+
4+
SPDX-License-Identifier: MIT
5+
-->
6+
17
# Agents working in this repo
28

39
Notes for AI assistants (Claude Code, Cursor, Continue, etc.) and humans pairing with them.
@@ -47,3 +53,21 @@ grep -c "define :" lib/access/access.ex lib/nbn/nbn.ex
4753
```
4854

4955
The two should match (modulo intentional exclusions).
56+
57+
## Before you commit
58+
59+
Two checks before any commit, every commit:
60+
61+
```bash
62+
mix format # auto-format every changed file to project style
63+
reuse lint # ensure every file has SPDX-FileCopyrightText + SPDX-License-Identifier
64+
```
65+
66+
New `.ex` / `.exs` files start with a comment header matching the existing
67+
files (see `lib/diffo_example/util.ex` for the canonical form). New markdown
68+
files use an HTML-comment variant (see `README.md`). `reuse lint` will tell
69+
you which files are missing copyright/license info; if you've created a
70+
new file and haven't added the header, this is the place to catch it.
71+
72+
Forgetting either is the easiest way to introduce CI noise the reviewer
73+
has to clean up. Save them both the time.

documentation/how_to/setup_mcp.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
<!--
2+
SPDX-FileCopyrightText: 2025 diffo_example contributors <https://github.com/diffo-dev/diffo_example/graphs.contributors>
3+
4+
SPDX-License-Identifier: MIT
5+
-->
6+
17
# Setting up the diffo_example MCP server
28

39
This how-to walks through running the diffo_example MCP server locally and

0 commit comments

Comments
 (0)