[OCaml] Mobile-friendly clone of cgit.
Add agent guidance.
Changed files
AGENTS.org
@@ -0,0 +1,51 @@
1
Added:
# -*- mode: org; -*-
2
Added:
3
Added:
#+TITLE: Agent guidance
4
Added:
#+AUTHOR: Marius Peter
5
Added:
#+DATE: <2026-07-09 Thu>
6
Added:
7
Added:
* Normative language
8
Added:
9
Added:
- SHALL :: mandatory.
10
Added:
- SHOULD :: expected unless there is a documented reason not to.
11
Added:
- MAY :: optional.
12
Added:
- MUST NOT :: prohibited.
13
Added:
14
Added:
* Context
15
Added:
16
Added:
** Scope
17
Added:
18
Added:
- This project SHALL implement a lightweight alternative to the cgit
19
Added:
software.
20
Added:
21
Added:
* Architecture
22
Added:
23
Added:
* Repository Map
24
Added:
25
Added:
- =README.org= :: describes the overall architecture.
26
Added:
- =bin/= :: contains the main ogit executable target.
27
Added:
- =lib/= :: contains libraries used by ogit.
28
Added:
- =test/= :: contains tests.
29
Added:
30
Added:
* Code
31
Added:
32
Added:
The public code repo is hosted at [[https://git.mlnp.fr/ogit]].
33
Added:
34
Added:
** Versions
35
Added:
36
Added:
- The project SHALL target OCaml 5.3.0.
37
Added:
38
Added:
** Structure
39
Added:
40
Added:
** Version control system
41
Added:
42
Added:
- The project SHALL use Git as its version control system.
43
Added:
- Commits created by an AI agent SHALL indicate so in the =user.name=
44
Added:
and =user.email= fields.
45
Added:
46
Added:
* Documentation
47
Added:
48
Added:
- This repository SHALL use Org Mode for project documentation. New
49
Added:
project docs SHALL use =.org= files.
50
Added:
- Architecture docs SHALL be updated when MQTT topics, payload schema,
51
Added:
host roles, or data flow change.
AGENTS.override.md
@@ -0,0 +1,3 @@
1
Added:
# AGENTS.override.md
2
Added:
3
Added:
Use the AGENTS.org file.