IEEE SA Open

Getting Started

Getting Started with IEEE SA Open

The IEEE SA Open platform serves multiple types of user, from a working group developing a new standard to a contributor who is excited to help grow an open source project. This document walks each user type through the necessary steps to successfully complete their work on the platform.

IEEE SA Open uses a custom version of GitLab. Users who plan to contribute to an IEEE SA Open Project will need a basic familiarity with GitLab: the searchable documentation is a valuable resource.


Standards Working Group
  • Select the Open Source Project Lead and Maintainer (this can be the same person). The Open Source Project Lead becomes an officer of the working group.
  • Submit the project request to OSCom.
  • Follow instructions from the OSCom administrator about presenting at the next monthly OSCom meeting.
  • Once the project is accepted by OSCom, the Open Source project lead should follow the workflow below.

Open Source Project Lead
  • Submit a CLA. Use the individual CLA if you are contributing as an individual, or use the Entity CLA if you are contributing as an employee.
    • For answers to common CLA questions, see the CLA FAQ.
  • Sign in to the IEEE SA Open GitLab using your IEEE single sign-on.
  • Choose an IEEE SA Open GitLab namespace.
  • Meet with the SA Open community management team to learn about your role and responsibilites as open source lead, and to learn about the initial commit process that is required for your project to be published publically.
  • Collect CLAs from all entities and individuals who created or will create any files that you plan to include in the project.
  • Complete the Initial Commit issue that the SA Open team has assigned to you in the GitLab project.

Open Source Project Member

  • Submit a CLA. Use the individual CLA if you are contributing as an individual, or use the Entity CLA if you are contributing as an employee.

    • For answers to common CLA questions, see the CLA FAQ.

  • Sign in to the IEEE SA Open GitLab using your IEEE single sign-on.

  • Ask the project’s Open Source lead to add you as a member of the project on which you’re working.

  • Contributing: Follow the project’s CONTRIBUTING.md guidelines, or follow the example below.

    • Example Contributing Guidelines
      • View the list of issues within the project.
      • If your work is not described in an exisiting issue, create a new issue describing the contribution you intend to make.
      • Create a new merge request (marked as draft) from the issue on which you plan to work.
      • Make commits inside the branch that was created by the merge request (named after the issue that you are working on).
      • Mark the merge request as ready. The project lead will be automatically notified by email that your merge request is ready to review and merge.

Contributor

  • Sign in to the IEEE SA Open GitLab using your IEEE single sign-on.

  • View the list of IEEE SA Open Projects and use the link from their project number to view the project in GitLab.

  • Contributing: Follow the project’s CONTRIBUTING.md guidelines, or follow the example below.

    • Example Contributing Guidelines
      • View the list of issues within the project to which you are interested in contributing.
      • If you see another way that you would like to contribute, create a new issue describing the contribution you intend to make.
      • Create a merge request (marked as draft) from the issue on which you plan to work.
      • Fork the project into your personal namespace. Make commits inside the branch that was created by the merge request (named after the issue that you are working on).
      • Mark the merge request as ready. The project lead will be automatically notified by email that your merge request is ready to review and merge.
      • The project lead may ask you to sign a CLA before your merge request is accepted.