Personal tools

API Change Proposal

From OpenLaszlo

10.23.2007

STEPS:

  1. Take this template and create a wiki page with your proposal.
  2. Add the proposal to the DRAFT PROPOSALS section on them Enhancement_Proposals wiki page
  3. Send the proposal to laszlo-dev with a link to the wiki page.
  4. The technical review committee will review the proposal and make a decision.

Contents

For API Additions

API Specification

code is fine

Justification for API Addition

When you describe the problem that your proposed API addreses, please be sure to provide answers to the following questions.

  • Why is this API change the best way to fix it?
  • Please give an example that shows why this API change is a good idea? (We may reuse this in the guide)
  • Does adding this API effectively deprecate another usage pattern?

For API Changes

Any API changes must maintain backwards compatibility for at least one major release (API is deprecated - but not recommended and will soon go away). Then, in a subsequent release, the old API can be removed.

API Specification

Specify the exact API change you are proposing (both old and new)

Justification for API Change

When you describe the problem that your API change addreses, please be sure to provide answers to the following questions.

  • Does this API change have any effect on existing code?
  • Explain how compatibility will be maintained (for the deprecation state)?
  • Justify why we should proceed with this change.