[
https://issues.apache.org/jira/browse/HDDS-15158?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Ivan Andika updated HDDS-15158:
-------------------------------
Description:
See https://matklad.github.io/2021/02/06/ARCHITECTURE.md.html
We can add AGENTS.md and CLAUDE.md for every subproject (e.g. Ozone, HDDS,
Recon, etc) to let codebase to be navigable and allow us to save context
tokens. Each AGENTS.md / CLAUDE.md only need to explain the implementation of
codes under its directory.
In the future, we can also add things like Hooks (e.g. checkstyle and PMD style
before pushing) and share useful skills that community have used.
Reference:
https://architecture.md/
https://github.com/tigerbeetle/tigerbeetle/blob/main/docs/ARCHITECTURE.md
https://claude.com/blog/how-claude-code-works-in-large-codebases-best-practices-and-where-to-start
Apache Dolphinscheduler: https://github.com/apache/dolphinscheduler/pull/18188
Apache Cassandra: https://github.com/apache/cassandra/pull/4734
Apache Airflow: https://github.com/apache/airflow/blob/main/AGENTS.md
Apache Fory: https://github.com/apache/fory/blob/main/AGENTS.md
was:
See https://matklad.github.io/2021/02/06/ARCHITECTURE.md.html
We can add AGENTS.md and CLAUDE.md for every subproject (e.g. Ozone, HDDS,
Recon, etc) to let codebase to be navigable and allow us to save context
tokens. Each AGENTS.md / CLAUDE.md only need to explain the implementation of
codes under its directory.
In the future, we can also add things like Hooks (e.g. checkstyle and PMD style
before pushing) and share useful skills that community have used.
Reference:
https://architecture.md/
https://github.com/tigerbeetle/tigerbeetle/blob/main/docs/ARCHITECTURE.md
https://claude.com/blog/how-claude-code-works-in-large-codebases-best-practices-and-where-to-start
Dolphinscheduler: https://github.com/apache/dolphinscheduler/pull/18188
Cassandra: https://github.com/apache/cassandra/pull/4734
Airflow: https://github.com/apache/airflow/blob/main/AGENTS.md
> Setup ARCHITECTURE.md, AGENTS.md and CLAUDE.md
> ----------------------------------------------
>
> Key: HDDS-15158
> URL: https://issues.apache.org/jira/browse/HDDS-15158
> Project: Apache Ozone
> Issue Type: Improvement
> Reporter: Ivan Andika
> Assignee: Ivan Andika
> Priority: Major
>
> See https://matklad.github.io/2021/02/06/ARCHITECTURE.md.html
> We can add AGENTS.md and CLAUDE.md for every subproject (e.g. Ozone, HDDS,
> Recon, etc) to let codebase to be navigable and allow us to save context
> tokens. Each AGENTS.md / CLAUDE.md only need to explain the implementation of
> codes under its directory.
> In the future, we can also add things like Hooks (e.g. checkstyle and PMD
> style before pushing) and share useful skills that community have used.
> Reference:
> https://architecture.md/
> https://github.com/tigerbeetle/tigerbeetle/blob/main/docs/ARCHITECTURE.md
> https://claude.com/blog/how-claude-code-works-in-large-codebases-best-practices-and-where-to-start
> Apache Dolphinscheduler: https://github.com/apache/dolphinscheduler/pull/18188
> Apache Cassandra: https://github.com/apache/cassandra/pull/4734
> Apache Airflow: https://github.com/apache/airflow/blob/main/AGENTS.md
> Apache Fory: https://github.com/apache/fory/blob/main/AGENTS.md
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
