marcieltorres/fast-api-boilerplate-project

Add AGENTS.md file for AI coding agent guidance

Open

#72 opened on Oct 23, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (0 forks)auto 404
documentationgood first issueia

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (PR metrics pending)

Description

Add an AGENTS.md file to provide standardized instructions for AI coding agents working on this project. This follows the open-source specification from https://agents.md/ and will help coding agents understand project-specific guidelines, build processes, and development workflows.

##The file should include:

  • Project overview and setup instructions
  • Build and test commands (make docker/install, poetry commands)
  • Code style guidelines (ruff configuration)
  • Testing conventions (pytest setup)
  • Commit message format
  • Security considerations for Slack bot development

This will improve consistency when AI tools assist with development tasks and provide a centralized location for agent-specific project guidance.

Contributor guide

Research direction
Create an AGENTS.md file following the agents.md specification with project specific guidelines as described in the issue.
Tech stack
pythonfastapi
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90