Skip to content

Latest commit

 

History

History
77 lines (53 loc) · 5.49 KB

cnti_best_practice_process.md

File metadata and controls

77 lines (53 loc) · 5.49 KB
Raw

Process to publish a CNTI Best Practice

Table of Contents

Understand the Mission Statement

The goal of the Cloud Native Telecom Initiative (CNTI) Best Practices focus area is to aid companies such as telecom vendors, communications service providers and large scale enterprises, running internal telecommunications-like infrastructure, to better understand what cloud native means for telecommunications workloads and help build consensus around industry adoption of cloud native technologies.

It is important that the best practices that we produce work towards that goal.

Please read the Charter and in particular the Mission Statement.

(Optional) Socialize the idea

Once you're sure the best practice aligns with the mission statement, it's sometimes a good idea to socialise the idea with the working group to get input and different perspectives, or to help focus the best practice on a specific topic.

The Best Practices focus area has the following communication channels:

Contribute the CNTI Best Practice Proposal

Read the Contributing Guide

Once you're ready to contribute the best practice, it's a good idea to read the contributing guide.

Create a GitHub Issue for a specific best practice idea

Ideally a set of best practices will have their own tickets.

  • First, check that there is not an existing issue (open or closed) covering the best practice suggestion.

    • If one is closed, then create a new issue and reference the old issue.
    • If an existing issue is currently open, add to the current issue unless the idea significantly changes it, in which case it should be in a new issue.
    • If an old suggestion was rejected, reference old issue and provide additional information on why the best practice should be reconsidered.

  • Each best practice will be published and recommended (if accepted) individually. Example: "use least privileges for containers" is a high level set of best practices. "Use non-root users in containers" is a single best practice.

  • It is important as the submitter that you respond to comments in the issue to ensure the proposal doesn't become "stale".

Create a Pull Request with the suggested CNTI Best Practice

  • Check that there is not an existing PR (open or closed) covering the best practice suggestion.
  • Create a draft following the template and existing best practices.
  • Tag current CNF WG members to review.
  • Note: PRs for related use stories and use cases can be created independently or combined with a suggested best practice as seems appropriate.

Communicate the PR and work to get it accepted

  • Respond to comments in the PR, and merge suggestions when agreed.
    • It is important to keep the PR active.
    • Because we're all volunteers, we try and keep the number of open PRs to a manageable level.
    • Therefore, co-chairs will look to close out PRs which have stalled with no progress and submitter is absent for more than 45/60 days.
  • If the PR is rejected, the co-chair(s) will communicate with the contributor, document the reason for rejection, and follow up in the related issue.
  • If the PR is accepted, it will be merged by one of the co-chairs.

Add to the list of CNTI Best Practices

Once the best practice PR has been accepted and merged, you can raise another PR to get the best practice added to the CNTI Best Practice List.