This page explains the process for contributing to the APIJSON project, including coding standards, pull request guidelines, and the community contribution workflow.
APIJSON is a Tencent-supported open-source project README.md1-3 that accepts contributions through GitHub Issues and Pull Requests at https The project actively seeks contributions to the core ORM library, documentation, ecosystem projects, and testing infrastructure CONTRIBUTING.md86-88 APIJSON has been under development for over 6 years and aims to provide a zero-code, full-featured, and secure ORM library CONTRIBUTING.md87-88
Sources: README.md1-3 CONTRIBUTING.md1-5 CONTRIBUTING.md86-88
Contributing code to the main repository is strongly encouraged to ensure your changes remain compatible with future versions and receive community maintenance CONTRIBUTING.md90-95
| Problem | Consequence |
|---|---|
| Maintenance Burden | You must manually merge your changes every time you upgrade the APIJSON version CONTRIBUTING.md94 |
| Incompatibility | Future updates to core classes may break your custom local modifications, leading to compilation or functional errors CONTRIBUTING.md93 |
| Undiscovered Bugs | Local code doesn't benefit from community peer review; others cannot help you find or fix bugs in your private fork CONTRIBUTING.md92 |
Sources: CONTRIBUTING.md90-95
The following diagram maps the logical contribution areas to the specific code entities within the repository.
Sources: CONTRIBUTING.md10-77 README.md12-18 CONTRIBUTING_COMMIT.md1-15 README-Chinese.md12-17
For minor documentation or typo fixes, use the GitHub web interface by clicking the edit (pencil) icon on the file page CONTRIBUTING.md103-107 Provide a brief modification description and click "Commit changes" CONTRIBUTING.md110-111
For significant modifications, follow the standard Fork-and-Pull model CONTRIBUTING.md114-116
Key Commands:
git clone git@github.com:<yourname>/APIJSON.git CONTRIBUTING.md126-128git remote add APIJSON git@github.com:Tencent/APIJSON.git CONTRIBUTING.md135-138git pull --rebase APIJSON master CONTRIBUTING.md148-152Sources: CONTRIBUTING.md118-152
APIJSON requires structured commit messages to facilitate automatic CHANGELOG generation CONTRIBUTING.md154-156 Messages follow the Angular specification consisting of a Header, Body, and Footer CONTRIBUTING_COMMIT.md7-15
The Header is mandatory and follows the format: <type>: <subject> CONTRIBUTING_COMMIT.md19-25
| Type | Purpose |
|---|---|
feat | New feature (Feature) CONTRIBUTING_COMMIT.md31 |
fix | Bug fix CONTRIBUTING_COMMIT.md32 |
doc | Documentation only changes CONTRIBUTING_COMMIT.md33 |
style | Formatting changes (no logic impact) CONTRIBUTING_COMMIT.md34 |
refactor | Code change that neither fixes a bug nor adds a feature CONTRIBUTING_COMMIT.md35 |
test | Adding missing tests CONTRIBUTING_COMMIT.md36 |
chore | Changes to build process or auxiliary tools CONTRIBUTING_COMMIT.md37 |
Subject Rules:
The Footer should be used for Breaking Changes or to link/close issues CONTRIBUTING_COMMIT.md64-70
issue #2 CONTRIBUTING_COMMIT.md77closes #1 (keywords: fix/fixes/fixed, close/closes/closed, resolve/resolves/resolved) CONTRIBUTING_COMMIT.md80-83Sources: CONTRIBUTING_COMMIT.md1-103
Before submitting a PR, ensure the following CONTRIBUTING.md172-182:
Maintainers review PRs for code quality, security, and performance CONTRIBUTING.md92 High-impact contributors are recognized in the acknowledgments section CONTRIBUTING.md6-83
Sources: CONTRIBUTING.md6-83 CONTRIBUTING.md172-182
APIJSON maintains a list of contributors from major organizations including Tencent, Microsoft, ByteDance, and various universities CONTRIBUTING.md6-78
The project tracks significant contributions through commit statistics CONTRIBUTING.md79-83:
Sources: CONTRIBUTING.md6-83
When reporting issues, contributors must CONTRIBUTING.md174-182:
The community uses several channels for coordination and documentation:
Sources: README.md13-17 README.md58-66 CONTRIBUTING.md170-182 README-Chinese.md13-16
Refresh this wiki