Permalink
Fetching contributors…
Cannot retrieve contributors at this time
43 lines (28 sloc) 1.78 KB
title issue state release
BP-XYZ: capation of bookkeeper proposal
one of ['Under Discussion', 'Accepted', 'Adopted', 'Rejected']
x.y.z

Motivation

Describe the problems you are trying to solve

Public Interfaces

Briefly list any new interfaces that will be introduced as part of this proposal or any existing interfaces that will be removed or changed. The purpose of this section is to concisely call out the public contract that will come along with this feature.

A public interface is any change to the following:

  • Data format, Metadata format
  • The wire protocol and api behavior
  • Any class in the public packages
  • Monitoring
  • Command line tools and arguments
  • Anything else that will likely break existing users in some way when they upgrade

Proposed Changes

Describe the new thing you want to do in appropriate detail. This may be fairly extensive and have large subsections of its own. Or it may be a few sentences. Use judgement based on the scope of the change.

Compatibility, Deprecation, and Migration Plan

  • What impact (if any) will there be on existing users?
  • If we are changing behavior how will we phase out the older behavior?
  • If we need special migration tools, describe them here.
  • When will we remove the existing behavior?

Test Plan

Describe in few sentences how the BP will be tested. We are mostly interested in system tests (since unit-tests are specific to implementation details). How will we know that the implementation works as expected? How will we know nothing broke?

Rejected Alternatives

If there are alternative ways of accomplishing the same thing, what were they? The purpose of this section is to motivate why the design is the way it is and not some other way.