Skip to content

docs: add agents guide for contributors#21587

Open
Justin-ZS wants to merge 4 commits intomasterfrom
codex/add-agents-md
Open

docs: add agents guide for contributors#21587
Justin-ZS wants to merge 4 commits intomasterfrom
codex/add-agents-md

Conversation

@Justin-ZS
Copy link
Copy Markdown
Contributor

@Justin-ZS Justin-ZS commented Apr 16, 2026

Brief Information

This pull request is in the type of:

  • bug fixing
  • new feature
  • others

What does this PR do?

Add a concise AGENTS.md at the repository root to summarize the repo layout, source-vs-generated files, contributor docs, and common local checks.

Fixed issues

  • N.A.

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.md that 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.

  • This PR doesn't relate to document changes
  • The document should be updated later
  • The document changes have been made in apache/echarts-doc#xxx

Misc

Security Checking

  • This PR uses security-sensitive Web APIs.

ZRender Changes

  • This PR depends on ZRender changes (ecomfe/zrender#xxx).

Related test cases or examples to use the new APIs

N.A.

Merging options

  • Please squash the commits into a single one when merging.

Other information

Validation not run because this is a documentation-only change.

@echarts-bot
Copy link
Copy Markdown

echarts-bot bot commented Apr 16, 2026

Thanks for your contribution!
The community will review it ASAP. In the meanwhile, please checkout the coding standard and Wiki about How to make a pull request.

The pull request is marked to be PR: author is committer because you are a committer of this project.

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: PR: doc ready, PR: awaiting doc, PR: doc unchanged

This message is shown because the PR description doesn't contain the document related template.

@echarts-bot
Copy link
Copy Markdown

echarts-bot bot commented Apr 16, 2026

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 PR: awaiting doc label.

@echarts-bot echarts-bot bot added PR: awaiting doc Document changes is required for this PR. and removed PR: doc ready labels Apr 16, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 16, 2026

The changes brought by this PR can be previewed at: https://echarts.apache.org/examples/editor?version=PR-21587@f64ba6b

@Justin-ZS Justin-ZS changed the title [codex] add agents guide for contributors docs: add agents guide for contributors Apr 16, 2026
@Justin-ZS Justin-ZS marked this pull request as ready for review April 16, 2026 09:50
@echarts-bot echarts-bot bot added PR: awaiting review PR: doc unchanged and removed PR: awaiting doc Document changes is required for this PR. labels Apr 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant