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: .github/AI_QUICK_START.md
+18-12Lines changed: 18 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -98,29 +98,35 @@ step showing how to install the Gemini CLI.
98
98
npm i -g @google/generative-ai/cli
99
99
```
100
100
101
-
## 5. The AI-Native Workflow in Action
101
+
## 5. The AI-Native Workflow: A Partnership
102
102
103
-
The goal of this system is not for you to manually run queries, but to empower an AI agent to do it for you. Here’s how
104
-
the intended workflow looks:
103
+
The goal of this system is to create a powerful partnership between you and the AI agent. To facilitate this, we use a dual-guide system:
104
+
105
+
- **`AGENTS.md`**: This is the rulebook for the **AI**. It contains the critical instructions, protocols, and constraints the agent must follow to be an effective contributor.
106
+
- **`WORKING_WITH_AGENTS.md`**: This is the playbook for **you**, the human developer. It provides essential strategies for guiding the agent, handling common issues, and maximizing its performance.
107
+
108
+
Your first step before starting a session should be to familiarize yourself with the `WORKING_WITH_AGENTS.md` guide.
109
+
110
+
### The Workflow in Action
111
+
112
+
Here’s how the intended workflow looks:
105
113
106
114
1. **Start your AI Agent**: From the repo root, launch your AI agent of choice (e.g., Gemini CLI).
107
115
```bash
108
116
gemini
109
117
```
110
-
2. **Give a High-Level Prompt**: Instead of feeding the AI context, you give it a goal and instruct it to use the tools
111
-
available in the repository.
118
+
2. **Give the Initial Handshake**: This is the most critical step. Your first prompt **must** direct the agent to its instructions.
119
+
> **Your Prompt:** "follow the instructions inside @AGENTS.md"
112
120
121
+
3. **Give a High-Level Prompt**: Once the agent has completed its initialization, you can give it a goal.
113
122
> **Your Prompt:** "Explain the Neo.mjs two-tier reactivity model and provide a simple code example."
114
123
115
-
3. **The AI Takes Over**: An AI agent following the `AGENTS.md` protocol will then:
124
+
4. **The AI Takes Over**: An agent following the `AGENTS.md` protocol will then:
116
125
* **Formulate a query**: It will determine that "reactivity" is the key concept.
117
-
* **Execute the tool**: It will run `npm run ai:query -- -q "reactivity" -t guide` and
118
-
`npm run ai:query -- -q "reactivity" -t src` on its own.
119
-
* **Synthesize the answer**: After getting the paths to the most relevant guides and source files, it will read
120
-
them and use that fresh, accurate context to generate a comprehensive explanation and code example.
126
+
* **Execute the tool**: It will run `npm run ai:query -- -q "reactivity" -t guide` on its own.
127
+
* **Synthesize the answer**: After getting the paths to the most relevant guides and source files, it will read them and use that fresh, accurate context to generate a comprehensive explanation.
121
128
122
-
This is the crucial difference: you are delegating the *research* task to the AI, making it a true partner that can
123
-
autonomously navigate and understand your codebase.
129
+
This is the crucial difference: you are delegating the *research* task to the AI, making it a true partner that can autonomously navigate and understand your codebase.
Copy file name to clipboardExpand all lines: .github/ISSUE/epic-hacktoberfest-2025.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,9 +31,9 @@ Let AI do the heavy lifting while you learn. The one-time setup takes about 15 m
31
31
-**Knowledge Base:** Building and querying the knowledge base uses the `text-embedding-004` model, which is free for up to **60 queries per minute**.
32
32
-**AI Agent:** For interactive development, if you use the Gemini CLI, it uses the `gemini-pro` model, which provides up to **3 million tokens per day for free**.
33
33
34
-
**1. Follow the [AI Knowledge Base Quick Start Guide](./AI_QUICK_START.md)**
35
-
36
-
This will walk you through building the local knowledge base that the AI uses to understand the project.
34
+
**1. Read the Guides:**
35
+
-**[Working with AI Agents](https://github.com/neomjs/neo/blob/dev/.github/WORKING_WITH_AGENTS.md):** First, read this playbook for you, the human developer. It provides essential strategies for guiding the agent and maximizing its performance.
36
+
-**[AI Knowledge Base Quick Start Guide](https://github.com/neomjs/neo/blob/dev/.github/AI_QUICK_START.md):** Then, follow this guide to build the local knowledge base that the AI uses to understand the project.
Copy file name to clipboardExpand all lines: .github/ISSUE/ticket-create-working-with-agents-guide.md
+9-4Lines changed: 9 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,8 +5,13 @@
5
5
6
6
## Description
7
7
8
-
Create a new guide, `WORKING_WITH_AGENTS.md`, to provide instructions for human developers on how to effectively interact with AI agents within this repository.
8
+
Create a new guide, `WORKING_WITH_AGENTS.md`, to provide comprehensive instructions for human developers on how to effectively and safely collaborate with AI agents within this repository.
9
9
10
-
This guide should cover two primary topics:
11
-
1.**Session Initiation:** How to start a session by instructing the agent to follow the rules in `AGENTS.md`.
12
-
2.**Error Recovery:** How to guide an agent to recover from mistakes, such as typos or getting stuck, by asking it to review its own actions.
10
+
This guide covers several critical topics:
11
+
1.**Session Initiation:** How to start a session correctly by directing the agent to `AGENTS.md`.
12
+
2.**Error Recovery:** How to guide an agent to recover from mistakes.
13
+
3.**Agent Behavior:** An explanation of non-determinism and accuracy, setting the right expectations.
14
+
4.**The "Golden Rule":** A critical safety rule about never using "Always Allow" for file modifications, backed by security research on agentic misalignment.
15
+
5.**Panic Responses:** How to spot and handle destructive agent behavior.
16
+
6.**The Session Lifecycle:** An analogy for understanding agent context degradation over time.
17
+
7.**Proactive Context Management:** A best practice for knowing when to start a fresh session.
0 commit comments