This page describes the Celeborn Improvement Proposal (CIP) process for proposing a major change to Celeborn.
To create your own CIP, click on "Create" on the header and choose "CIP-Template" other than "Blank page".
- Purpose
- What is considered a "major change" that needs a CIP?
- What should be included in a CIP?
- Process
- CIP round-up
The purpose of CIPs is to have a central place to collect and document planned major enhancements to Apache Celeborn. While JIRA is still the tool to track tasks, bugs, and progress, the CIPs give an accessible high level overview of the result of design discussions and proposals. Think of CIPs as collections of major design documents for user-relevant changes.
What is considered a "major change" that needs a CIP?
Any of the following should be considered a major change:
- Any major new feature, subsystem, or piece of functionality
- Any change that impacts the public interfaces of the project
What are the "public interfaces" of the project?
All of the following are public interfaces that people build around:
- Protocol between services
- Storage formats
- Configuration settings
- Exposed monitoring information