This page provides an overview of project operations for APIJSON, covering community contribution workflows, issue tracking templates, test suites, and documentation asset management.
As a parent page, it summarizes the core operational pillars and links to detailed child pages for specific procedures:
APIJSON encourages community participation through GitHub Issues and Pull Requests. Contributors can submit small fixes directly via the GitHub web editor or perform a full fork-and-rebase workflow for larger features and architectural modifications as detailed in CONTRIBUTING.md1-158.
To maintain bug report quality and ensure that maintainers can reproduce issues efficiently, structured issue templates are enforced. For example, .github/ISSUE_TEMPLATE/bug_report.yml:1-84 requires explicit input regarding APIJSON versioning, database environments, and complete APIAuto request/response logs.
For detailed guidelines on forking, branch management, commit conventions, and issue filing rules, see Contributing and Issue Workflow.
Title: Contribution and Issue Routing Architecture
Sources: CONTRIBUTING.md:1-158, .github/ISSUE_TEMPLATE/bug_report.yml:1-84
The APIJSON project maintains a comprehensive test suite using JUnit, housed primarily within APIJSONORM/src/test. These tests validate core framework behaviors, including automated ORM query parsing, custom reference path resolution, fake delete mechanisms, and database-specific dialect compatibility (such as Kingbase and PostgreSQL).
Automated tests serve as regression guards when updating parsing pipelines or query syntax rules. For full documentation on test execution procedures, method directives, and specific test cases, see Testing.
Title: Testing Suite Execution Flow
Sources: README.md:1-64
The project repository includes structured documentation assets, architectural navigation guides (Navigation.md), project roadmaps (Roadmap.md), and visual assets stored in assets/. These assets support multi-language documentation (README.md, README-Chinese.md) and provide context for architectural decisions.
For more information on repository asset conventions, architectural reference files, and historical design artifacts, see Documentation Assets and Design History.
Title: Documentation and Asset Organization
Sources: README.md:1-64, README-Chinese.md:1-64
Refresh this wiki
This wiki was recently refreshed. Please wait 6 days to refresh again.