openGauss is an open source community. It fully relies on the friendly development and collaboration environment provided by the community.
Before contributing to the community, read and comply with the openGauss Community Code of Conduct of openGauss community.
1. Sign up for Gitee Account
The source code of openGauss source code is hosted on Gitee: https://gitee.com/opengauss
Please refer to https://gitee.com/help/articles/4113 to register your Gitee account and Set up your primary E-mail at http://gitee.com/profile/emails.
2. Signing the Contributor License Agreement (CLA)
Please sign the Contributor License Agreement (CLA) before participating in the community contribution.
3. Finding Your Interests
The openGauss community is organized based on different SIGs (Special Interest Groups), facilitating the management and improvement of working processes. SIGs are open to everyone to make contributions.Each SIG has one or more projects on Gitee, and these projects have one or more repositories. Issues can be submitted in the repository corresponding to the SIG where specific issues can be discussed, submitted, resolved, and reviewed. You can find the SIGs you are interested in from the SIG list below.
| SIG Name | Scope of Responsibility | Maillist |
|---|---|---|
| SQLEngine | Develop and maintain the SQL engines of the openGauss community. | sqlengine@opengauss.org |
| StorageEngine | Develop and maintain the storage engine of the openGauss community. | storageengine@opengauss.org |
| Connectors | Develop and maintain the connectors of the openGauss community. | connectors@opengauss.org |
| Tools | Develop and maintain the tools of the openGauss community. | tools@opengauss.org |
| Docs | Develop and maintain the documents of the openGauss community. | docs@opengauss.org |
| Infra | Develop and maintain the infrastructure of the openGauss community. | infra@opengauss.org |
| Security | Develop and maintain the security of the openGauss community. | securities@opengauss.org |
| OM | Develop and maintain the operation and deployment of openGauss. | om@opengauss.org |
| IoT | Develop and maintain the IoT of the openGauss community. | iot@opengauss.org |
| In-place Update | Develop and maintain the in-place update of the openGauss community. | inplaceupdate@opengauss.org |
| AI | Develop and maintain the AI of the openGauss community. | ai@opengauss.org |
| GIS | Develop and maintain the Geographic Information System of the openGauss community. | gis@opengauss.org |
| CloudNative | Develop and maintain the Cloud Native of the openGauss community. | cloudnative@opengauss.org |
| SecurityTechnology | Develop and maintain the database security technology of the openGauss community. | securitytechnology@opengauss.org |
| Certification | Responsible for the openGauss certification process, definition and development of test suites. | certification@opengauss.org |
| Plugin | Build, manage and develop the plugin framework. | plugin@opengauss.org |
| Blockchain | Explore the blockchain use case, Study the core technical issues of blockchain. | blockchain@opengauss.org |
| DCF | Develop and maintain Distributed Consensus Framework of the openGauss community. | dcf@opengauss.org |
| QA | Develop and maintain released version quality of the openGauss community. | QA@opengauss.org |
| Graph | Responsible for the knowledge map data management function of unified storage and query of the openGauss community. | graph@opengauss.org |
| ReleaseManagement | The community collaborates with SIG Maintainers to plan openGauss community release and is responsible for the final competitiveness goal. | releasemanagement@opengauss.org |
| CM | Provides the opengauss database with the capabilities of active/standby status monitoring, network communication fault monitoring, file system fault monitoring, and automatic active/standby switchover. | cm@opengauss.org |
| OPS | Focus on building openGauss maintenance capabilities, improve product operation and maintenance capabilities, and summarize and transfer operation and maintenance experience. | ops@opengauss.org |
| KnowledgeGraph | Carry out research on the whole life cycle of knowledge graph, construction, storage management and application | knowledgegraph@opengauss.org |
Want to start a new SIG?
Please send your application to: tc@opengauss.org , the email template is referred to: https://gitee.com/opengauss/tc/blob/master/sigs/Template/README.md .
4. Starting Your Contribution
4.1 Assigning an Issue to Yourself
Firstly find the Issue list for the openGauss community: https://gitee.com/organizations/opengauss/issues
If you want to process one of the Issues, you can assign it to yourself. Enter /assign in the comment box, and then the robot will assign the issue to you. Participants communicate and discuss on each issue page. You can leave your opinions in the comment box.
4.2 Submitting Issue
If you are going to report bugs or submit requirements to the community, please submit Issue on the corresponding repository of openGauss community. If you don't know which repository the bug or requirement belongs to, please go to the Community repository to submit Issue. You can also contribute your own opinions or suggestions to the opengauss community in the form of Issue. Please refer to Issue Submit Guide for Issue submission.
4.3 Submitting Pull Request
When you submit a Pull Request, it means that you have started to contribute code to the community. See openGauss Community Pull Request Submission Guide for more details. If a large amount of code needs to be submitted at a time, it is recommended that you break down large content into a series of logically small content and submit them separately to help reviewers understand your ideas. If your Pull Request does not draw enough attention, you can seek help through the Mailing Lists or IRC channels of different SIGs.
4.4 Reviewing Code
openGauss is an open community, we hope that all participants in the community are active reviewers. The Gentle Art Of Patch Review puts forward a series of review focuses, explaining that the review is to promote the participation of new contributors and prevent the contributors from being overwhelmed by subtle errors at the beginning.
5. Community Membership
We encourage all contributors to become members. We aim to grow an active, healthy community of contributors. Please get more information about the community membership including Maintainer and Committer in the Community Membership introducation.