Skip to content

Profile Creation Process

John Leung edited this page Jul 31, 2024 · 1 revision

Profile versioning

The versioning of a profile uses the syntax Major.Minor.Errata

  • An increment of the Major revision signifies that a pre-existing requirement has changed, thereby breaking backward compatibility
  • An increment of the Minor revision signifies that the change has added incremental requirements, but pre-existing requirements have not changed
  • An increment of Errata revision signifies that no requirements have changed (use to handle typo's etc.)

Github Process for repository

Issue is Opened – initial submittal

  • Community clarifies issue via comments. Comments can be made individually or during a meeting. Comments may include guidance for the solution.
  • Community will accept/approve or reject the issue. The issue shall be labeled as 'approved', or 'wontfix'.
  • The issue may be labeled as 'duplicate', 'bug', 'enhancement', 'documentation'
  • Someone volunteers to resolve the issue

Assignee forks the repository

  • Assignee makes a pull request. The issue # will be in the pull request comments
  • When the pull request is ready to be merged, the PR shall be labeled 'Ready to Review'

Pull Request - ‘ready to review'

  • Reviewers are assigned to verify or test the PR.
  • Once verified by a reviewer, a comment will be added. Once all the verifications are complete, the PR is labeled “verified” by the reviewers.
  • Community discusses and approves the pull request. TSC arbitrates any disputes. Once approved, the PR shall be label 'Approved to Merge'
  • Project leadership merges the pull request

Profile and Usage Guide Process

The usage guide corresponds to a profile and is the document which is reviewed by the community and approved by the OCP Incubation Committee.

  • Errata changes generally do not require an update to the Usage Guide
  • Minor and Major changes do require an update to the Usage Guide. Hence, the Usage Guide changes should be reviewed and approved before the corresponding usage guide is updated.