This is an automated email from the ASF dual-hosted git repository.
chaokunyang pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/fory.git
The following commit(s) were added to refs/heads/main by this push:
new fd1d53bd0 docs: add AGENTS to readme (#2844)
fd1d53bd0 is described below
commit fd1d53bd0fbbc5e0ce6d53ef7a2ca06935539abf
Author: Shawn Yang <[email protected]>
AuthorDate: Wed Oct 29 00:46:32 2025 +0800
docs: add AGENTS to readme (#2844)
<!--
**Thanks for contributing to Apache Fory™.**
**If this is your first time opening a PR on fory, you can refer to
[CONTRIBUTING.md](https://github.com/apache/fory/blob/main/CONTRIBUTING.md).**
Contribution Checklist
- The **Apache Fory™** community has requirements on the naming of pr
titles. You can also find instructions in
[CONTRIBUTING.md](https://github.com/apache/fory/blob/main/CONTRIBUTING.md).
- Apache Fory™ has a strong focus on performance. If the PR you submit
will have an impact on performance, please benchmark it first and
provide the benchmark result here.
-->
## Why?
<!-- Describe the purpose of this PR. -->
## What does this PR do?
<!-- Describe the details of this PR. -->
## Related issues
<!--
Is there any related issue? If this PR closes them you say say
fix/closes:
- #xxxx0
- #xxxx1
- Fixes #xxxx2
-->
## Does this PR introduce any user-facing change?
<!--
If any user-facing interface changes, please [open an
issue](https://github.com/apache/fory/issues/new/choose) describing the
need to do so and update the document if necessary.
Delete section if not applicable.
-->
- [ ] Does this PR introduce any public API change?
- [ ] Does this PR introduce any binary protocol compatibility change?
## Benchmark
<!--
When the PR has an impact on performance (if you don't know whether the
PR will have an impact on performance, you can submit the PR first, and
if it will have impact on performance, the code reviewer will explain
it), be sure to attach a benchmark data here.
Delete section if not applicable.
-->
---
CONTRIBUTING.md | 2 ++
README.md | 6 ++----
docs/guide/DEVELOPMENT.md | 2 ++
3 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 01f6134a0..1c5bb9102 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -227,3 +227,5 @@ If you want write a blog, or update other contents about
the website, please sub
## Development
For more information, please refer to [Development
Guide](https://fory.apache.org/docs/docs/guide/development).
+
+See [AGENTS](AGENTS.md) for detailed guidelines and best practices for AI
coding agents working on the Apache Fory codebase.
diff --git a/README.md b/README.md
index 330b31eab..764fc787a 100644
--- a/README.md
+++ b/README.md
@@ -595,10 +595,8 @@ We welcome contributions! Please read our [Contributing
Guide](CONTRIBUTING.md)
See [Development Guide](docs/guide/DEVELOPMENT.md) for build instructions and
development workflow.
+See [AGENTS](AGENTS.md) for detailed guidelines and best practices for AI
coding agents working on the Apache Fory codebase.
+
## License
Apache Fory™ is licensed under the [Apache License 2.0](LICENSE).
-
-## Acknowledgments
-
-Apache Fory™ is an [Apache Software Foundation](https://apache.org/) project,
developed and maintained by contributors worldwide. We thank all contributors
for their valuable contributions to the project.
diff --git a/docs/guide/DEVELOPMENT.md b/docs/guide/DEVELOPMENT.md
index 8ac96d9cc..551e8eb5b 100644
--- a/docs/guide/DEVELOPMENT.md
+++ b/docs/guide/DEVELOPMENT.md
@@ -147,3 +147,5 @@ prettier --write "**/*.md"
## Contributing
For more information, please refer to [How to contribute to Apache
Fory™](https://github.com/apache/fory/blob/main/CONTRIBUTING.md).
+
+See [AGENTS](https://github.com/apache/fory/blob/main/AGENTS.md) for detailed
guidelines and best practices for AI coding agents working on the Apache Fory
codebase.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
