Conversation
|
Thanks for your contribution! The pull request is marked to be To reviewers: If this PR is going to be described in the changelog in the future release, please make sure this PR has one of the following labels: This message is shown because the PR description doesn't contain the document related template. |
|
Document changes are required in this PR. Please also make a PR to apache/echarts-doc for document changes and update the issue id in the PR description. When the doc PR is merged, the maintainers will remove the |
|
The changes brought by this PR can be previewed at: https://echarts.apache.org/examples/editor?version=PR-21587@f64ba6b |
Brief Information
This pull request is in the type of:
What does this PR do?
Add a concise
AGENTS.mdat the repository root to summarize the repo layout, source-vs-generated files, contributor docs, and common local checks.Fixed issues
Details
Before: What was the problem?
There was no short repo-specific orientation document for coding agents or contributors, so basic repository context had to be reconstructed from the codebase and supporting docs each time.
After: How does it behave after the fixing?
The repo now includes an
AGENTS.mdthat briefly explains the project layout, the role of export and entry files, which files are generated, which contributor-facing docs to follow, and the main local validation commands.Document Info
One of the following should be checked.
Misc
Security Checking
ZRender Changes
Related test cases or examples to use the new APIs
N.A.
Merging options
Other information
Validation not run because this is a documentation-only change.