Skip to content

Docs: Create AGENTS.md for AI assistant #157

Description

@Ubayed-Bin-Sufian

Description

The repository currently lacks an AGENTS.md file to provide project-specific instructions for AI coding assistants and human contributors. Adding this will establish clear guardrails for code generation and manual contributions.

Proposed Changes

Add an AGENTS.md file in the repository root containing:

  • Project Overview: High-level summary of the application and its goals.
  • Technology Stack: Core languages, frameworks, and tools used.
  • Repository Structure: Directory layout to help agents navigate the codebase.
  • Coding Standards: Language-specific conventions and formatting rules.
  • Commit Style Guidelines: Expected commit message formats (e.g., conventional commits).
  • UI Guidelines: Design patterns, component rules, and styling principles.

Benefits

  • Helps AI coding assistants generate more accurate, idiomatic, and consistent code suggestions.
  • Provides human contributors with a quick, centralized overview of project conventions.

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions