Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 

Proposing Changes to M3

Introduction

The design process for changes to M3 is loosely modeled on the proposal process used by the Go project.

Process

  • Create an issue describing the proposal.

  • Like any GitHub issue, a proposal issue is followed by an initial discussion about the suggestion. For Proposal issues:

    • The goal of the initial discussion is to reach agreement on the next step: (1) accept, (2) decline, or (3) ask for a design doc.
    • The discussion is expected to be resolved in a timely manner.
    • If the author wants to write a design doc, then they can write one.
    • A lack of agreement means the author should write a design doc.
  • If a Proposal issue leads to a design doc:

    • The design doc should be presented as a Google Doc and must follow the template.
    • The design doc should be linked from the opened GitHub issue.
    • The design doc should only allow edit access to authors of the document.
    • Do not create the document from a corporate G Suite account, if you wish to edit from a corporate G Suite account then first create the document from a personal Google account and grant edit access to your corporate G Suite account.
    • Comment access should be granted explicitly to m3db@googlegroups.com so that users viewing the document display under their account names rather than anonymous users.
    • Comment access should also be accessible by the public, make sure this is the case by clicking "Share" and "Get shareable link" ensuring to select "Anyone with the link can comment".
  • Once comments and revisions on the design doc wind down, there is a final discussion about the proposal.

    • The goal of the final discussion is to reach agreement on the next step: (1) accept or (2) decline.
    • The discussion is expected to be resolved in a timely manner.
  • Once the design doc is agreed upon, the author shall export the contents of the Google Doc as a Markdown document and submit a PR to add it to the proposal repository

    • For now we will use gdocs2md and any cleanup required must be done by hand by the author.
    • The design doc should be checked in at design/XYZ-shortname.md, where XYZ is the GitHub issue number and shortname is a short name (a few dash-separated words at most).
    • The design doc should be added to the list of existing proposals in index.md
  • The author (and/or other contributors) do the work as described by the "Implementation" section of the proposal.

Approval

The proposal requires approval from all Technical Steering Committee (the "TSC") members.

The current TSC members are:

  • @jimjag (Uber)
  • @martin-mao (Chronosphere)
  • @mway (Uber)
  • @prateek (Uber)
  • @robskillington (Chronosphere)

While the TSC aims to operate as a consensus-based community, if any TSC decision requires a vote to move the proposal forward, decisions by vote require a majority vote of all TSC members.


This project is released under the Apache License, Version 2.0.

About

M3 Design Documents

Resources

License

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •