AI4J 贡献指南

This page is the documentation entry point for contributors. The repository's full contribution guide is authoritative for source changes and pull requests.

Choose a path

• Report a reproducible defect through Issues.
• Discuss a larger API or product change in Discussions before implementing it.
• Start with a scoped good first issue when you are new to the project.
• Send documentation fixes from docs-site/ with the checks below.

Open pull requests against main. Keep one logical change per pull request and state the exact verification command in its description.

Documentation changes

From docs-site/, install dependencies and run the same local checks used by the documentation workflow:

npm ci
npm run typecheck
npm run check:docs
npm run build

Keep conceptual pages linked from the sidebar, preserve redirects when moving a public route, and verify examples against the current source before calling a feature supported.

Java changes

AI4J is a Java 8 Maven monorepo. Build or test the smallest affected module first, then expand verification when the change crosses module boundaries.

mvn -pl <module> -am -DskipTests=false test

The contribution guide defines the current branch, compatibility, commit, and review expectations.

Security and conduct

Report security issues privately

Do not disclose a security vulnerability in a public issue. Follow the repository's security policy instead. Participation is governed by the Code of Conduct.