Abhishek Chaudhary created FINERACT-2942:
--------------------------------------------
Summary: Point agents at the fineract-command migration guide and
reference features
Key: FINERACT-2942
URL: https://issues.apache.org/jira/browse/FINERACT-2942
Project: Apache Fineract
Issue Type: Improvement
Components: Docs
Reporter: Abhishek Chaudhary
Fix For: 1.16.0
h3. Background
AGENTS.md currently only points agents at SECURITY.md. For write requests the
code has two styles: the legacy command pipeline (about 460 handlers) and the
typed fineract-command infrastructure from FSIP-5 (about 50). An agent that
reads the surrounding code mostly sees the legacy style and copies it. Guidance
on how new code should look already exists in fineract-command/REFACTORING.md,
the fineract-command README and the command chapter of the docs, but nothing
points agents at it.
h3. Proposal
Add a "Command processing (write requests)" section to AGENTS.md that:
* names the building blocks of the new style: request and response DTOs, a
Command subclass, a CommandHandler, CommandDispatcher in the REST resource, and
services that take typed requests
* lists the legacy API that new code does not use
* points at two migrated features as reference implementations: payment types
and document management
* links REFACTORING.md, the fineract-command README, the command docs chapter
and the FSIP-5 wiki page
* says that where the documentation and the reference implementations disagree,
the reference implementations win
h3. Open question
Whether a new write endpoint in a feature that has not been migrated yet should
use fineract-command, or match the legacy handlers around it, is not written
down anywhere. The section leaves that case out; it is FSIP-5's call.
h3. Discussion
dev@: [Need reviews of open PRs, plus
AI|https://lists.apache.org/thread/xcw8djv45t4sjok5pj9rt750tn20pdnb]
Earlier suggestion to grow AGENTS.md: [Guidelines regarding AI-assisted
development|https://lists.apache.org/thread/o3wp081gntybvp3cdvp47co6fk1fvfho]
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
