SIG Participation Guide

A SIG is a group focused on a specific interest area, contributing its outputs back to the broader community.

All SIGs operate transparently, allowing contributors to easily join and participate in their areas of interest.

SIG Creation

To initiate the creation of a SIG (Special Interest Group), submit a GitHub Pull Request to the SIG repository under the Linyaps community organization. You must create a folder for the SIG in the specified directory and include the required files. The Linyaps Community SIG Committee will review the request through the Pull Request review process. Once the Pull Request is merged, the SIG creation is complete, and the organization administrators will configure permissions and create dedicated repositories based on the submitted SIG materials.

  • The SIG folder in this repository is only for storing basic information files. For hosting source code or other group-specific resources, edit relevant files during the creation steps.

SIG Creation Requirements

Before creating a SIG, ensure the group meets the following criteria:

  • The group’s interests and activities are relevant to the Linyaps community, including but not limited to ecosystem contributions or downstream development.

  • The group maintains public activity.

  • The group’s activities contribute to the broader Linyaps community.

  • The group has at least two members (recommended: five or more members).

  • Activities may be hosted on any platform. For public instant messaging platforms, ensure privacy protection during communications.

  • To facilitate contributions and collaboration, a sig- prefixed repository will be created under the OpenAtom-Linyaps organization upon request. If the group already uses an external platform, specify this during creation.

Information Preparation

Prepare the following details before creating a SIG:

  • SIG name (recommended in both Chinese and English).

  • Group ID (lowercase letters and hyphens only).

  • Creation rationale.

  • Group introduction.

  • Scope and objectives.

  • Public communication channels.

  • Member information and GitHub accounts of SIG administrators.

Once ready, proceed to the next steps.

Creation Steps

  1. Fork the SIG repository of the Linyaps community organization.

  2. Copy the files from the .sig-template.zh_CN directory into a new folder named with your group ID.

  3. Edit the files in this new folder to reflect your SIG’s details.

  4. Push the changes and submit a Pull Request.

Template Editing Notes:

  • Information declared in metadata.yml will be publicly displayed.

  • Members listed in metadata.yml will be invited to join the OpenAtom-Linyaps organization.

Pull Request Format:

  • Title: [New SIG Proposal] SIG Name

  • Description:

    • Explain the rationale for creating the SIG.

    • Provide GitHub account details of SIG administrators in metadata.yml.

    • List member GitHub usernames and profiles in MEMBERS.md.

Example description:

## SIG Creation Rationale
​
Describe the purpose of creating this SIG here.
​
## Repository Request
​
This SIG requests the following repositories under the OpenAtom-Linyaps organization:
​
- `sig-group-id`
- ...
​
(Note: Remove the "Repository Request" section if no repositories are needed.)

Required Files:

  • MEMBERS.md

  • metadata.yml

  • README.md

If unfamiliar with GitHub Pull Request workflows, open an Issue with the above information to request assistance from the SIG Committee.

Post-Creation Steps

  • The SIG Committee will respond within three business days. Address feedback via discussions in the Pull Request.

  • Once merged, the SIG is officially created. Close the Pull Request if the SIG is no longer needed.

SIG Modification Process

To update SIG information, submit a Pull Request to edit existing files. The SIG Committee will review and merge changes.

If unfamiliar with Pull Requests, open an Issue to request assistance.

Post-Creation Repository Requests

To request additional repositories after SIG creation:

  • Issue Title: [New SIG Repository Request] SIG Name

  • Description:

  • New SIG Repository Rationale

    Explain the need for the new repository here.

Feedback and Communication Channels

For questions or feedback, use the following:

  • SIG-specific communication channels.

  • GitHub Issues in the relevant repositories.

Note: While SIGs may create repositories under OpenAtom-Linyaps, activities are not restricted to this organization. SIGs may use other platforms (e.g., Gitee) or GitHub organizations for collaboration.