Repository navigation
Contributing
Contributions are welcome under the project's GPL-2.0-or-later license. This page summarizes CONTRIBUTING.md; that file and AGENTS.md remain authoritative.
Read docs/en/development.md, docs/en/security/threat-model.md and docs/en/architecture/overview.md. Security-sensitive work also needs a threat-model update and negative permission tests. If a change touches an adapter API, verify the installed version instead of assuming a signature (AGENTS.md).
- Fork the repository and branch from
main. - Use the naming convention below. One pull request solves one problem.
- Keep the branch rebased on
main; no merge commits. - Open the pull request against upstream
mainand fill every section of the template: problem, behavior, validation, risks, rollback and the security invariants reviewed. - Wait for the required checks and a code-owner review. No self-merge, and no force-push after review starts.
- A maintainer squash-merges; delete the branch afterwards.
| Prefix | Use |
|---|---|
feature/<ticket>-<short-description> |
New behavior |
bugfix/<ticket>-<short-description> |
Defect repair |
refactor/<ticket>-<short-description> |
Internal restructuring |
docs/<short-description> |
Documentation only |
chore/<short-description> |
Tooling and maintenance |
release/<version> / hotfix/<ticket>
|
Maintainer release work |
Do not push directly to main. Commit and push only when the project owner has explicitly authorized it (CONTRIBUTING.md, AGENTS.md).
Conventional Commits, in English, are mandatory:
<type>(<scope>): <subject>
Examples from CONTRIBUTING.md:
feat(auth): add ip cidr filtering to token validationfix(ratelimit): prevent race condition in atomic counterdocs(vi): update installation guide and architecture specstest(mcp): add negative test cases for invalid origin headerchore(deps): pin ajv for wp-env compatibility
Keep formatting-only changes out of a behavior commit. A commit that mixes unrelated work is a review problem, not a convenience.
A pull request must show these contexts green before merge (CONTRIBUTING.md, .github/CI_GUIDE.md):
| Check | Covers |
|---|---|
ci-result |
Aggregate of the source gate: quality, bootstrap syntax, unit matrix, integration matrix, build, tooling |
Complete source coverage and regression gate |
Five-suite coverage collection, thresholds and no-regression baseline |
workflow-lint |
actionlint, zizmor, workflow hardening and contract tests |
Secret detection (Gitleaks) |
Pull-request commit range and final merge tree |
Static analysis (Semgrep) |
p/php rule pack |
Filesystem vulnerability scan (Trivy) |
Dependency and filesystem findings |
Composer and npm advisories |
Published advisories for locked dependencies |
plugin-check and sbom are path-filtered and not required. Release and changelog workflows run on tags, compliance runs weekly, documentation deploy runs on documentation changes, and the performance workflow runs only on manual dispatch.
Locally, run composer check before requesting review; add composer test:packaging and composer build when packaging or runtime behavior changes. Integration, HTTP and browser suites run through the shared lab, never locally (see Testing).
A behavior change updates its documents in the same pull request:
| Change | Update |
|---|---|
| Hook or route |
docs/en/architecture/overview.md, CHANGELOG.md
|
| Ability schema | Ability catalog, integration and output-pipeline tests |
| Security boundary | Threat model, security tests, SECURITY.md when disclosure scope changes |
| Translation string |
languages/xnetvn-agent-hub-wp.pot via bash bin/make-pot.sh
|
| Configuration |
docs/en/INSTALL.md, docs/en/ENVIRONMENT.md
|
English is the source of truth; docs/vi/ mirrors it, and bin/check-docs-parity.py enforces both parity and relative links. Source comments, UI source strings and canonical documentation are English; ability descriptions stay fixed English because MCP clients read them (CONTRIBUTING.md, AGENTS.md).
Do not open a public issue for a vulnerability. Report it privately to security@xnetvn.net with affected versions, a minimal reproduction, observed impact and environment details, and remove passwords, keys, personal data and authorization headers. Do not post exploit details or secrets publicly.
SECURITY.md states that the project promises no response deadline or supported release period before its first stable release, and readme.txt states there is no bug bounty. GitHub private vulnerability reporting is a separate repository setting and has not been verified. The permanent exclusions — arbitrary SQL, PHP or shell execution, file editors, secret access and key management through MCP — are described in the threat model.
All contributors follow CODE_OF_CONDUCT.md: an inclusive, open, respectful and professional environment. Unacceptable behavior is handled through the channels named there.
Reviewers check the security invariants, not only style. Deny-only filters must not widen access, tier filters must not lower risk, and the output pipeline must still validate after redaction. A change that bypasses the private registry, the exact route match or the AuthContext requirement is rejected regardless of test coverage. See Security-Model for the invariants and Release-and-Versioning for what happens after merge.
xNetVN Agent Hub WP · GPL-2.0-or-later · Copyright (c) 2026 xNetVN Inc.
This wiki summarizes the repository documentation. The source of truth is the repository; when they disagree, the repository wins.
Start here
Using the plugin
Security
Engineering
Project