Skip to main content

BEEP 1 - Purpose and Guidelines

· 2 min read
Nick Tchayka
STATUS - IN PROGRESS

What is a BEEP?​

BEEP stands for Booster Evolution Enhancement Proposal. It is a document that describes a change or addition to Booster.

Statuses of a BEEP​

A BEEP can have one of the following statuses:

STATUS - DRAFT

This status indicates that the BEEP is still being written and is not ready for review.

STATUS - IN PROGRESS

This status indicates that the BEEP has been accepted but is still being implemented.

STATUS - INTEGRATED

This status indicates that the BEEP has been implemented.

STATUS - ACCEPTED

This status is for informational BEEPs that have been accepted.

STATUS - REJECTED

This status indicates that the BEEP has been rejected.

How to contribute to the design process​

Everyone is welcome to propose, discuss, and review ideas to improve Booster in the #proposals channel of the Discord server.

Note that the project is in a very early stage, and the contribution to the design process is not well defined.

As some general rules for now, take this into account before submitting a proposal:

  • No "What about if Booster does a 180-degree turn and instead does this completely unrelated thing?". These kinds of proposals are seen as completely out of the scope of the Booster project and will be instantly dismissed.
  • Use constructive criticism. Instead of "remove this, I don't like it", take a moment to think and give actual reasons like "I believe that this function in the standard library is not clear enough, someone could understand this in a wrong way"
  • Is the problem being addressed impactful enough to warrant a change to Booster?
  • How does this impact the Principle of Least Astonishment of the project?
  • How does this impact the Principle of Developer Happiness of the project?
  • How does this impact the Principle of Least Effort of the project? Both externally for the users and internally for the maintainers.
  • Does this proposal fit well with the feel and direction of Booster?
  • What other libraries/languages got you inspired to submit this proposal? How does this compare to those?
  • How much effort did you put into your review? A glance, a quick reading, or an in-depth study?

Please state explicitly whether you believe that the proposal should be accepted into Booster.