mirror of
				https://github.com/shokinn/hosts-go.git
				synced 2025-11-04 04:28:34 +00:00 
			
		
		
		
	docs: add project agents guidance
This commit is contained in:
		
							parent
							
								
									3c239e68f3
								
							
						
					
					
						commit
						3f794786b6
					
				
					 1 changed files with 26 additions and 0 deletions
				
			
		
							
								
								
									
										26
									
								
								AGENTS.md
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										26
									
								
								AGENTS.md
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
					@ -0,0 +1,26 @@
 | 
				
			||||||
 | 
					# AGENTS
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Memory Bank Requirements
 | 
				
			||||||
 | 
					- **Always read the Memory Bank before starting any task.**
 | 
				
			||||||
 | 
					- Memory Bank lives in `memory-bank/` and contains:
 | 
				
			||||||
 | 
					  - `projectbrief.md`
 | 
				
			||||||
 | 
					  - `productContext.md`
 | 
				
			||||||
 | 
					  - `systemPatterns.md`
 | 
				
			||||||
 | 
					  - `techContext.md`
 | 
				
			||||||
 | 
					  - `activeContext.md`
 | 
				
			||||||
 | 
					  - `progress.md`
 | 
				
			||||||
 | 
					- The Memory Bank is the single source of project context. If a user requests **update memory bank**, review every file in the directory before making changes.
 | 
				
			||||||
 | 
					- After significant work or when insights are gained, update `activeContext.md` and `progress.md`. Create additional files in `memory-bank/` when useful for organizing new documentation.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Development Guidelines
 | 
				
			||||||
 | 
					- **Language:** Go using modules.
 | 
				
			||||||
 | 
					- **Formatting:** run `gofmt -w` on modified Go files.
 | 
				
			||||||
 | 
					- **Testing:** practice TDD and run `go test ./...` before committing.
 | 
				
			||||||
 | 
					- **Linting:** run `golangci-lint run` when available.
 | 
				
			||||||
 | 
					- **Structure:** keep application code inside `internal/` packages and follow existing patterns for `core`, `tui`, and `utils`.
 | 
				
			||||||
 | 
					- **Error Handling:** return errors instead of panicking and provide clear messages.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Commit Process
 | 
				
			||||||
 | 
					- Ensure Memory Bank is updated when project state changes.
 | 
				
			||||||
 | 
					- Run the formatting, lint, and test commands above.
 | 
				
			||||||
 | 
					- Commit only when the worktree is clean and all commands pass.
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue