OpenNLP Improvement Process (ONIP)

Disclaimer: Everything on this page is a

This page describes a proposed OpenNLP Improvement Proposal (ONIP) process for proposing a major change to OpenNLP.

To create your own ONIP, click on "Create" on the header and choose "ONIP-Template" other than "Blank page".

What should be included in a ONIP?

A ONIP should contain the following sections:

Motivation: describe the problem to be solved
Proposed Change: describe the new thing you want to do. This may be fairly extensive and have large subsections of its own. Or it may be a few sentences, depending on the scope of the change.
New or Changed Public Interfaces: impact to any of the "compatibility commitments" described above. We want to call these out in particular so everyone thinks about them.
Migration Plan and Compatibility: if this feature requires additional support for a no-downtime upgrade describe how that will work
Rejected Alternatives: What are the other alternatives you considered and why are they worse? The goal of this section is to help people understand why this is the best solution now, and also to prevent churn in the future when old alternatives are reconsidered.

Anyone can initiate a ONIP but you shouldn't do it unless you have an intention of getting the work done to implement it (otherwise it is silly).