You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+12-7Lines changed: 12 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,15 +1,15 @@
1
1
# AGENTS.md
2
2
3
-
AI Agent Guide for Sourcerer development.
3
+
AI Agent Guide for AsciiSourcerer development.
4
4
5
5
<!-- tag::universal-agency[] -->
6
6
## AI Agency
7
7
8
-
As an LLM-backed agent, your primary mission is to assist a human Operator in the development, documentation, and maintenance of Sourcerer by following best practices outlined in this document.
8
+
As an LLM-backed agent, your primary mission is to assist a human Operator in the development, documentation, and maintenance of AsciiSourcerer by following best practices outlined in this document.
As an AI agent working on Sourcerer, approach this codebase like an **inquisitive and opinionated junior engineer with senior coding expertise and experience**.
12
+
As an AI agent working on AsciiSourcerer, approach this codebase like an **inquisitive and opinionated junior engineer with senior coding expertise and experience**.
13
13
In particular, you values:
14
14
15
15
-**Documentation-first development:** Always read the docs first, understand the architecture, then propose solutions at least in part by drafting docs changes
@@ -89,6 +89,8 @@ Before making any changes, **read these documents in order**:
89
89
90
90
## Codebase Architecture
91
91
92
+
> **NOTE:** The internal namespce for this gem is `Sourcerer`, not `AsciiSourcerer`. `AsciiSourcerer` is the public-facing gem name and a permanent alias for the `Sourcerer` module, but internal code should use `Sourcerer` to avoid confusion.
93
+
92
94
### Core Components
93
95
94
96
```
@@ -104,8 +106,8 @@ specs/tests/ # Tests and fixtures
104
106
105
107
### Configuration System
106
108
107
-
Sourcerer does not ship a formal configuration definition file at this stage.
108
-
When configuration is needed, it is typically provided by the calling project (for example, ReleaseHx) via `.sourcerer.yml` or direct Ruby arguments.
109
+
This gem does not ship a formal configuration definition file at this stage.
110
+
When configuration is needed, it is typically provided by the calling project (for example, ReleaseHx) via `.asciisourcerer.yml` or direct Ruby arguments.
109
111
110
112
<!-- tag::universal-approach -->
111
113
@@ -123,7 +125,7 @@ When configuration is needed, it is typically provided by the calling project (f
123
125
124
126
## Working with Demo Data
125
127
126
-
No demo repo is currently wired for Sourcerer.
128
+
No demo repo is currently wired for AsciiSourcerer.
127
129
Use `specs/tests/fixtures/` and `specs/tests/rspec/` to validate behavior.
128
130
129
131
<!-- tag::universal-responsibilities[] -->
@@ -164,7 +166,10 @@ When troubleshooting or planning, be inquisitive about:
164
166
165
167
## Remember
166
168
167
-
Sourcerer is a DocOps Lab core dependency used by other gems and tooling.
169
+
AsciiSourcerer is a DocOps Lab core dependency used by other gems and tooling.
170
+
171
+
Internally, we work on the Sourcerer module and ignore the AsciiSourcerer namespace, which is an alias.
172
+
168
173
Prefer stability, clarity, and backward compatibility over experimentation.
0 commit comments