Contributing

Relevant source files

• CONTRIBUTING.md
• CONTRIBUTING_COMMIT.md
• LICENSE
• README-Chinese.md
• README.md

APIJSON welcomes contributions from the global developer community. This page provides an overview of contribution opportunities, the existing contributor base, and high-level guidance on participating in the project.

For detailed procedures:

• Code contributions (workflow, standards, pull requests): See page How to Contribute
• Bug reporting (templates, required information, APIAuto screenshots): See page Bug Reporting
• Development environment setup (IDE, build, testing): See page Development Setup

---

Types of Contributions

APIJSON welcomes diverse contributions to improve the project:

Contribution Type	Examples	Prerequisites
Code	Bug fixes, new features, performance improvements, refactoring	Java knowledge, understanding of APIJSON architecture
Documentation	README improvements, protocol examples, translations, typo fixes	Writing skills, APIJSON usage knowledge
Testing	Test cases, bug reports, validation	APIJSON usage experience, APIAuto familiarity
Community Support	Answering issues, helping users, reviewing PRs	APIJSON expertise
Ecosystem Projects	Client SDKs, language ports, plugins, tools	Programming in target language
Evangelism	Blog posts, tutorials, conference talks, videos	Communication skills, APIJSON experience

License: APIJSON is licensed under the Apache License 2.0 LICENSE1-6 permitting free commercial and non-commercial use by individuals, companies, and organizations worldwide README.md1-3

Sources: CONTRIBUTING.md1-10 README.md1-3 LICENSE1-6

---

The APIJSON Contributor Community

APIJSON has attracted a diverse community of contributors from leading technology companies and institutions. The project has a significant number of contributors CONTRIBUTING.md8-77 who have made improvements to the codebase.

Notable Contributors

The contributor base includes engineers from:

Organization	Contributors
Tencent	TommyLemon (creator), fineday009, caohao-go, Wscats, jun0315, haolingzhang1 CONTRIBUTING.md10-41
ByteDance	qiujunlin, andream7 CONTRIBUTING.md36-37
Microsoft	andream7 CONTRIBUTING.md36
NetEase	HANXU2018 CONTRIBUTING.md38
Alibaba Cloud	cnscoo CONTRIBUTING.md56
Zhihu	sunxiaoguang (Infrastructure Architect) CONTRIBUTING.md24
YTO Express	yeyuezhishou CONTRIBUTING.md34
Universities	gdjs2 (UC Riverside), Rkyzzy (SUSTech, UC Berkeley), kxlv2000 (SUSTech) CONTRIBUTING.md27-29

Contribution Statistics

Major contributors have made substantial code contributions CONTRIBUTING.md79-83:

• cloudAndMonkey: 11 commits, +1,496 additions, -845 deletions CONTRIBUTING.md80
• justinfengchen: 6 commits, +3,130 additions CONTRIBUTING.md81
• Zerounary: 6 commits, +1,104 additions CONTRIBUTING.md83
• ruoranw: 18 commits, +328 additions CONTRIBUTING.md82

The project has also spawned an ecosystem of related projects in multiple programming languages including Java, Go, C#, PHP, Node.js, Python, Rust, and Lua README.md58-67

Sources: CONTRIBUTING.md6-83 README.md58-67

---

Contribution Workflow Overview

APIJSON supports two contribution workflows depending on the change size. For complete workflow details, see page How to Contribute.

High-Level Contribution Process

Sources: CONTRIBUTING.md99-181 CONTRIBUTING_COMMIT.md1-103

---

Repository Structure and Contribution Targets

APIJSON consists of multiple repositories. Understanding the structure helps identify where to contribute.

Repository and Code Entity Map

Contribution Target Matrix

Where to contribute based on what you want to improve:

Target Area	Repository	Key Files/Classes
Documentation	Tencent/APIJSON	README.md, CONTRIBUTING.md README.md1-18 CONTRIBUTING.md1-106
Core Processing	APIJSON/apijson-orm	AbstractParser, AbstractObjectParser
SQL Generation	APIJSON/apijson-orm	AbstractSQLConfig
Security	APIJSON/apijson-orm	AbstractVerifier
Server Demos	APIJSON/APIJSON-Demo	APIJSONBoot/, MultiDataSource/ README.md21-55

Sources: CONTRIBUTING.md1-15 README.md21-67

---

Why Contribute Code to APIJSON?

Contributing code directly to APIJSON (rather than maintaining a private fork) provides significant benefits CONTRIBUTING.md90-95:

1. Visibility: Others can see your changes and help find/fix bugs CONTRIBUTING.md92
2. Compatibility: Your changes stay compatible with new APIJSON versions CONTRIBUTING.md93
3. Maintenance: You avoid the burden of manually merging private changes into new upstream versions CONTRIBUTING.md94
4. Career: Contributions to a major Tencent open source project enhance your resume and professional profile CONTRIBUTING.md91

Sources: CONTRIBUTING.md90-96

---

Contribution Standards

All contributions must meet quality standards to ensure project maintainability.

Critical Requirements

Before submitting ANY contribution:

1. ✓ Search existing issues CONTRIBUTING.md178
2. ✓ Read contribution guidelines CONTRIBUTING.md174
3. ✓ For code: Follow conventional commits specification CONTRIBUTING_COMMIT.md1-103 Common types include:
   • feat: New features CONTRIBUTING_COMMIT.md31
   • fix: Bug fixes CONTRIBUTING_COMMIT.md32
   • doc: Documentation changes CONTRIBUTING_COMMIT.md33
   • refactor: Code changes that neither fix a bug nor add a feature CONTRIBUTING_COMMIT.md35
4. ✓ For code: Ensure changes are tested and do not break the core ORM protocol.

⚠️ Sensitivity Warning: APIJSON is strictly sensitive to syntax and formatting. Ensure your contributions adhere to the protocol's requirements regarding case sensitivity and structure.

Sources: CONTRIBUTING.md156-181 CONTRIBUTING_COMMIT.md1-103

---

Development Resources

Contribution Paths

For detailed contribution procedures including fork/clone workflow, coding standards, and PR guidelines, see page How to Contribute.

Sources: CONTRIBUTING.md99-167