Overview

The openUBMC community fosters a friendly environment for development and collaboration. Please read and adhere to the Code of Conduct before contributing.

Contribution Procedure

Step 1: Register a GitCode Account

• openUBMC uses GitCode as its code hosting repository. https://gitcode.com/org/openUBMC

• Refer to the GitCode User Guide to register your GitCode account and set your primary email in user settings.

Step 2: Sign the CLA

• Before participating in community contributions, you must sign the Contributor License Agreement (CLA).

Step 3: Find a SIG You Are Interested In

• openUBMC community content is structured around Special Interest Groups (SIGs) to streamline management and workflow. All SIGs are open and welcome contributions from everyone.

To get started, Find a SIG that Aligns with Your Interests.

• View SIG organizational details via the SIG Center page or the repository. All SIG meetings are public and open for you to join anytime.

• We also encourage interaction with SIG members via the Forum or email.。

• Interested SIG not listed? Start a new one! Send your application to tc@public.openubmc.cn，. Refer to the Application Process for the email template.

Step 4: Start Your Contribution

Contribution extends beyond code. Your input is valuable in every facet of the community.

Code Contributions

Each SIG maintains its own planned issues. You can select and resolve an issue based on your interest.

Assign an Issue to Yourself

Type /assign in the comment box, and the bot will assign the issue to you. If there is an ongoing discussion, feel free to post your feedback or join the conversation in the comments.

Submit an Issue

To report a bug or submit a feature request, create an issue in the corresponding openUBMC community repository. If you are unsure which repository to use, post a query on the Forum first.

You can also propose ideas or suggestions via an issue or by starting a topic on the Forum. Refer to the GitCode Issue Submission Guide for details.

Submit a Pull Request (PR)

Refer to the openUBMC Community Pull Request Submission Guide. For substantial contributions, you are highly advised to break down the content into a series of smaller, logically segmented commits for easier code review.

If your PR stalls, you can escalate it and request help through the SIG's mailing list or the forum.

Review Code

As an open community, we expect all participants to be active reviewers. For guidance on code review, refer to the The Gentle Art of Patch Review. Key review points to focus on:

• Contribution relevance: Evaluate if the contributor's idea is reasonable and aligns with the project's goals and needs.

• Architectural adherence: Check if the contributed code adheres to the correct architectural design and is consistent with existing codebase and design principles.

• Contribution completeness: Assess if the code is comprehensive, includes all necessary features and tests, and demonstrates maintainability and extensibility.

Non-Code Contributions

A thriving community is built on more than just code. It relies on the continuous efforts of active developers across all domains. Non-code contributions include, but are not limited to:

Documentation Development

• If you find issues while reading openUBMC community documentation, provide feedback by submitting an issue or posting on the Forum.

• Have your own insights? Feel free to publish your own documentation. Refer to the openUBMC Blog Contribution Guide or contact sig-docs via email/forum for available submission methods.

Testing and Validation

• Ready to harden the quality of community releases? Get involved with sig-QA.

Other Work

• Community interaction: Engage in discussions, mentor new contributors, and answer community queries on the Forum.

• Community operations support: Assist SIG maintainers in improving SIG homepage information, organizing community meetings, and more.

• Becoming a community evangelist: Co-organize community gatherings, including meetups, live streams, and the Developer Day.

• Community promotion and content creation: Submit event news, technical posts, courseware, or videos to the Technical Committee (TC).

• Community infrastructure development: Join sig-infrastructure.

• Community visual design: Contact the TC.

• Community translation services: Reach out to the TC.

Step 5: Grow with the Community

• We welcome all contributions to the openUBMC community. Our goal is to foster an active and healthy community driven by its contributors. For details on roles like maintainer and committer, refer to the SIG Center page.