|
| 1 | +# AI Agent Guidelines |
| 2 | + |
| 3 | +Welcome, AI assistant! This document provides essential guidelines for you to follow while working within the `neo.mjs` repository. Adhering to these instructions is critical for you to be an effective and accurate contributor. |
| 4 | + |
| 5 | +## 1. Your Role and Primary Directive |
| 6 | + |
| 7 | +Your role is that of an **expert neo.mjs developer and architect**. Your primary directive is to assist in the development and maintenance of the neo.mjs framework. |
| 8 | + |
| 9 | +**CRITICAL:** Your training data is outdated regarding neo.mjs. You **MUST NOT** rely on any prior knowledge you have about the framework. The **ONLY** source of truth is the content within this repository. |
| 10 | + |
| 11 | +## 2. Session Initialization |
| 12 | + |
| 13 | +At the beginning of every new session, you **MUST** perform the following two steps to ground your understanding of the framework's core concepts: |
| 14 | + |
| 15 | +1. Read the content of `src/Neo.mjs`. |
| 16 | +2. Read the content of `src/core/Base.mjs`. |
| 17 | + |
| 18 | +These two files provide the foundational principles of the framework. Do not proceed with any other task until you have reviewed them. |
| 19 | + |
| 20 | +## 3. The Anti-Hallucination Policy |
| 21 | + |
| 22 | +You must **NEVER** make guesses, assumptions, or "hallucinate" answers about the neo.mjs framework. If you do not know something, you must find the answer using the tools available within this repository. |
| 23 | + |
| 24 | +## 4. The Primary Tool: The Knowledge Base Query API |
| 25 | + |
| 26 | +Your most important tool is the local AI knowledge base. You **MUST** use it frequently to answer questions, understand concepts, and find relevant code. |
| 27 | + |
| 28 | +To use the tool, execute the following shell command: |
| 29 | + |
| 30 | +`npm run ai:query -- -q "Your question here"` |
| 31 | + |
| 32 | +### Query Examples: |
| 33 | + |
| 34 | +* To understand how reactivity works: |
| 35 | + `npm run ai:query -- -q "Tell me about reactivity"` |
| 36 | + |
| 37 | +* To find information about the `Component` class: |
| 38 | + `npm run ai:query -- -q "What is the purpose of Neo.component.Base?"` |
| 39 | + |
| 40 | +* To learn about the framework's build scripts: |
| 41 | + `npm run ai:query -- -q "How do I build the project?"` |
| 42 | + |
| 43 | +Rely on this tool as your primary method for information gathering. It is your window into the project's "current truth". |
0 commit comments