CarGDev/avante.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix typo

Browse Source
This commit is contained in:
samuelm00
2025-08-19 06:32:27 +02:00
committed by yetone
parent 6da110b1c0
commit 24f7dbbe76
1 changed files with 56 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

106
README.md
View File

@@ -63,81 +63,87 @@ If you like this project, please consider supporting me on Patreon, as it helps
- **One-Click Application**: Quickly apply the AI's suggested changes to your source code with a single command, streamlining the editing process and saving time. - **One-Click Application**: Quickly apply the AI's suggested changes to your source code with a single command, streamlining the editing process and saving time.
- **Project-Specific Instruction Files**: Customize AI behavior by adding a markdown file (`avante.md` by default) in the project root. This file is automatically referenced during workspace changes. You can also configure a custom file name for tailored project instructions. - **Project-Specific Instruction Files**: Customize AI behavior by adding a markdown file (`avante.md` by default) in the project root. This file is automatically referenced during workspace changes. You can also configure a custom file name for tailored project instructions.
## Project Instructions with avante.md ## project instructions with avante.md
The `avante.md` file allows you to provide project-specific context and instructions to the AI. This file should be placed in your project root and will be automatically referenced during all interactions with Avante. the `avante.md` file allows you to provide project-specific context and instructions to the ai. this file should be placed in your project root and will be automatically referenced during all interactions with avante.
### Best Practices for avante.md ### best practices for avante.md
To get the most out of your project instruction file, consider following this structure: to get the most out of your project instruction file, consider following this structure:
#### Your Role #### your role
Define the AI's persona and expertise level for your project: define the ai's persona and expertise level for your project:
```markdown ```markdown
### Your Role ### your role
You are an expert senior software engineer specializing in [technology stack]. You have deep knowledge of [specific frameworks/tools] and understand best practices for [domain/industry]. You write clean, maintainable, and well-documented code. You prioritize code quality, performance, and security in all your recommendations. you are an expert senior software engineer specializing in [technology stack]. you have deep knowledge of [specific frameworks/tools] and understand best practices for [domain/industry]. you write clean, maintainable, and well-documented code. you prioritize code quality, performance, and security in all your recommendations.
``` ```
#### Your Mission #### your mission
Clearly describe what the AI should focus on and how it should help: clearly describe what the ai should focus on and how it should help:
```markdown ```markdown
### Your Mission ### your mission
Your primary goal is to help build and maintain [project description]. You should: your primary goal is to help build and maintain [project description]. you should:
- Provide code suggestions that follow our established patterns and conventions - provide code suggestions that follow our established patterns and conventions
- Help debug issues by analyzing code and suggesting solutions - help debug issues by analyzing code and suggesting solutions
- Assist with refactoring to improve code quality and maintainability - assist with refactoring to improve code quality and maintainability
- Suggest optimizations for performance and scalability - suggest optimizations for performance and scalability
- Ensure all code follows our security guidelines - ensure all code follows our security guidelines
- Help write comprehensive tests for new features - help write comprehensive tests for new features
``` ```
#### Additional Sections to Consider #### additional sections to consider
- **Project Context**: Brief description of the project, its goals, and target users - **project context**: brief description of the project, its goals, and target users
- **Technology Stack**: List of technologies, frameworks, and tools used - **technology stack**: list of technologies, frameworks, and tools used
- **Coding Standards**: Specific conventions, style guides, and patterns to follow - **coding standards**: specific conventions, style guides, and patterns to follow
- **Architecture Guidelines**: How components should interact and be organized - **architecture guidelines**: how components should interact and be organized
- **Testing Requirements**: Testing strategies and coverage expectations - **testing requirements**: testing strategies and coverage expectations
- **Security Considerations**: Specific security requirements or constraints - **security considerations**: specific security requirements or constraints
### Example avante.md ### example avante.md
```markdown ```markdown
# Project Instructions for MyApp # project instructions for myapp
## Your Role ## your role
You are an expert full-stack developer specializing in React, Node.js, and TypeScript. You understand modern web development practices and have experience with our tech stack.
## Your Mission you are an expert full-stack developer specializing in react, node.js, and typescript. you understand modern web development practices and have experience with our tech stack.
Help build a scalable e-commerce platform by:
- Writing type-safe TypeScript code
- Following React best practices and hooks patterns
- Implementing RESTful APIs with proper error handling
- Ensuring responsive design with Tailwind CSS
- Writing comprehensive unit and integration tests
## Project Context ## your mission
MyApp is a modern e-commerce platform targeting small businesses. We prioritize performance, accessibility, and user experience.
## Technology Stack help build a scalable e-commerce platform by:
- Frontend: React 18, TypeScript, Tailwind CSS, Vite
- Backend: Node.js, Express, Prisma, PostgreSQL
- Testing: Jest, React Testing Library, Playwright
- Deployment: Docker, AWS
## Coding Standards - writing type-safe typescript code
- Use functional components with hooks - following react best practices and hooks patterns
- Prefer composition over inheritance - implementing restful apis with proper error handling
- Write self-documenting code with clear variable names - ensuring responsive design with tailwind css
- Add JSDoc comments for complex functions - writing comprehensive unit and integration tests
- Follow the existing folder structure and naming conventions
## project context
myapp is a modern e-commerce platform targeting small businesses. we prioritize performance, accessibility, and user experience.
## technology stack
- frontend: react 18, typescript, tailwind css, vite
- backend: node.js, express, prisma, postgresql
- testing: jest, react testing library, playwright
- deployment: docker, aws
## coding standards
- use functional components with hooks
- prefer composition over inheritance
- write self-documenting code with clear variable names
- add jsdoc comments for complex functions
- follow the existing folder structure and naming conventions
``` ```
## Installation ## Installation
@@ -162,7 +168,7 @@ For building binary if you wish to build from source, then `cargo` is required.
---@type avante.Config ---@type avante.Config
opts = { opts = {
-- add any opts here -- add any opts here
-- this file can containe specific instructions for your project -- this file can contain specific instructions for your project
instructions_file = "avante.md" instructions_file = "avante.md"
-- for example -- for example
provider = "claude", provider = "claude",