You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@fineract.apache.org by James Dailey <jd...@apache.org> on 2024/05/10 16:55:24 UTC

Significant Improvement Proposals (SIP) TEMPLATE

Community -

In other Apache Top Level Projects there is the notion of a SIP
(Significant Improvement Proposal).  The SIP is intended to signal that
"hey, pay attention, this is important".  It does not apply to small code
changes, or to features, but rather to architecture or testing frameworks,
or significant efforts to be undertaken.

We've had something like that at Apache Fineract(R) but, speaking as a
member of the PMC, I think we should formalize this a bit more. So, I'm
bringing this here.  If there are objections within 72 hrs, let's please
use this template structure.

A Fineract-SIP should have the following things:

*Title: Specific Idea*

*Summary*
     the TL;DR

*Status*:  Under Discussion, Proposed, VOTE, Accepted/Rejected, Under
Development, Stalled, Completed
       NOTE:  This is per our normal process of Discussion, Proposal, Vote
and then takes it to the next step of tracking the SIP over time.

*Who is involved*:   Owner and collaborators

*Background/Motivation*
      NOTE:  Why are we considering this?

*Goals and Exclusions*
     NOTE:  List high level goals and also things this will NOT address.

*Change Proposed*
examples.... and be specific
    Architectural changes
    Significant re-factoring
    Test Framework
    API versioning

*Alternatives Considered*
    Note: Why this specific approach to the challenge.

*Phases of work*
    Note:  Specific timelines or "gates".   We do this, learn that, then
proceed.

Examples from other Apache projects.
https://spark.apache.org/improvement-proposals.html
https://cwiki.apache.org/confluence/display/KAFKA/Kafka%20Improvement%20Proposals
https://cwiki.apache.org/confluence/display/BEAM/Beam+Improvement+Proposals
https://github.com/apache/pulsar/blob/master/pip/README.md

- jdailey

Re: Significant Improvement Proposals (SIP) TEMPLATE

Posted by James Dailey <ja...@gmail.com>.
+1.
Thank you
Adopted



On Tue, May 14, 2024 at 7:10 AM VICTOR MANUEL ROMERO RODRIGUEZ <
victor.romero@fintecheando.mx> wrote:

> +1
>
> El lun, 13 may 2024 a las 12:15, Aleksandar Vidakovic (<
> cheetah@monkeysintown.com>) escribió:
>
>> +1
>>
>> Note: there is at least one example based on our previous discussions in
>> Jira https://issues.apache.org/jira/browse/FINERACT-1908
>>
>> On Mon, May 13, 2024 at 8:51 AM John Gathogo <jo...@fiter.io> wrote:
>>
>>> In support of this.
>>>
>>> On Fri, May 10, 2024 at 7:56 PM James Dailey <jd...@apache.org> wrote:
>>>
>>>> Community -
>>>>
>>>> In other Apache Top Level Projects there is the notion of a SIP
>>>> (Significant Improvement Proposal).  The SIP is intended to signal that
>>>> "hey, pay attention, this is important".  It does not apply to small code
>>>> changes, or to features, but rather to architecture or testing frameworks,
>>>> or significant efforts to be undertaken.
>>>>
>>>> We've had something like that at Apache Fineract(R) but, speaking as a
>>>> member of the PMC, I think we should formalize this a bit more. So, I'm
>>>> bringing this here.  If there are objections within 72 hrs, let's please
>>>> use this template structure.
>>>>
>>>> A Fineract-SIP should have the following things:
>>>>
>>>> *Title: Specific Idea*
>>>>
>>>> *Summary*
>>>>      the TL;DR
>>>>
>>>> *Status*:  Under Discussion, Proposed, VOTE, Accepted/Rejected, Under
>>>> Development, Stalled, Completed
>>>>        NOTE:  This is per our normal process of Discussion, Proposal,
>>>> Vote and then takes it to the next step of tracking the SIP over time.
>>>>
>>>> *Who is involved*:   Owner and collaborators
>>>>
>>>> *Background/Motivation*
>>>>       NOTE:  Why are we considering this?
>>>>
>>>> *Goals and Exclusions*
>>>>      NOTE:  List high level goals and also things this will NOT
>>>> address.
>>>>
>>>> *Change Proposed*
>>>> examples.... and be specific
>>>>     Architectural changes
>>>>     Significant re-factoring
>>>>     Test Framework
>>>>     API versioning
>>>>
>>>> *Alternatives Considered*
>>>>     Note: Why this specific approach to the challenge.
>>>>
>>>> *Phases of work*
>>>>     Note:  Specific timelines or "gates".   We do this, learn that,
>>>> then proceed.
>>>>
>>>> Examples from other Apache projects.
>>>> https://spark.apache.org/improvement-proposals.html
>>>>
>>>> https://cwiki.apache.org/confluence/display/KAFKA/Kafka%20Improvement%20Proposals
>>>>
>>>> https://cwiki.apache.org/confluence/display/BEAM/Beam+Improvement+Proposals
>>>> https://github.com/apache/pulsar/blob/master/pip/README.md
>>>>
>>>> - jdailey
>>>>
>>>

Re: Significant Improvement Proposals (SIP) TEMPLATE

Posted by VICTOR MANUEL ROMERO RODRIGUEZ <vi...@fintecheando.mx>.
+1

El lun, 13 may 2024 a las 12:15, Aleksandar Vidakovic (<
cheetah@monkeysintown.com>) escribió:

> +1
>
> Note: there is at least one example based on our previous discussions in
> Jira https://issues.apache.org/jira/browse/FINERACT-1908
>
> On Mon, May 13, 2024 at 8:51 AM John Gathogo <jo...@fiter.io> wrote:
>
>> In support of this.
>>
>> On Fri, May 10, 2024 at 7:56 PM James Dailey <jd...@apache.org> wrote:
>>
>>> Community -
>>>
>>> In other Apache Top Level Projects there is the notion of a SIP
>>> (Significant Improvement Proposal).  The SIP is intended to signal that
>>> "hey, pay attention, this is important".  It does not apply to small code
>>> changes, or to features, but rather to architecture or testing frameworks,
>>> or significant efforts to be undertaken.
>>>
>>> We've had something like that at Apache Fineract(R) but, speaking as a
>>> member of the PMC, I think we should formalize this a bit more. So, I'm
>>> bringing this here.  If there are objections within 72 hrs, let's please
>>> use this template structure.
>>>
>>> A Fineract-SIP should have the following things:
>>>
>>> *Title: Specific Idea*
>>>
>>> *Summary*
>>>      the TL;DR
>>>
>>> *Status*:  Under Discussion, Proposed, VOTE, Accepted/Rejected, Under
>>> Development, Stalled, Completed
>>>        NOTE:  This is per our normal process of Discussion, Proposal,
>>> Vote and then takes it to the next step of tracking the SIP over time.
>>>
>>> *Who is involved*:   Owner and collaborators
>>>
>>> *Background/Motivation*
>>>       NOTE:  Why are we considering this?
>>>
>>> *Goals and Exclusions*
>>>      NOTE:  List high level goals and also things this will NOT address.
>>>
>>>
>>> *Change Proposed*
>>> examples.... and be specific
>>>     Architectural changes
>>>     Significant re-factoring
>>>     Test Framework
>>>     API versioning
>>>
>>> *Alternatives Considered*
>>>     Note: Why this specific approach to the challenge.
>>>
>>> *Phases of work*
>>>     Note:  Specific timelines or "gates".   We do this, learn that, then
>>> proceed.
>>>
>>> Examples from other Apache projects.
>>> https://spark.apache.org/improvement-proposals.html
>>>
>>> https://cwiki.apache.org/confluence/display/KAFKA/Kafka%20Improvement%20Proposals
>>>
>>> https://cwiki.apache.org/confluence/display/BEAM/Beam+Improvement+Proposals
>>> https://github.com/apache/pulsar/blob/master/pip/README.md
>>>
>>> - jdailey
>>>
>>

SIP Security Framework jira #1908

Posted by James Dailey <ja...@gmail.com>.
Alexander -  since we discussed the issue below; we can say it’s an
approved SIP.  No need to retroactively go through this.

However as an Approved SIP, the best practice would be good to get an
update on that SIP.

?  Adam?

Sent from Gmail Mobile


On Mon, May 13, 2024 at 11:15 AM Aleksandar Vidakovic <
cheetah@monkeysintown.com> wrote:

> +1
>
> Note: there is at least one example based on our previous discussions in
> Jira https://issues.apache.org/jira/browse/FINERACT-1908
>
> On Mon, May 13, 2024 at 8:51 AM John Gathogo <jo...@fiter.io> wrote:
>
>> In support of this.
>>
>> On Fri, May 10, 2024 at 7:56 PM James Dailey <jd...@apache.org> wrote:
>>
>>> Community -
>>>
>>> In other Apache Top Level Projects there is the notion of a SIP
>>> (Significant Improvement Proposal).  The SIP is intended to signal that
>>> "hey, pay attention, this is important".  It does not apply to small code
>>> changes, or to features, but rather to architecture or testing frameworks,
>>> or significant efforts to be undertaken.
>>>
>>> We've had something like that at Apache Fineract(R) but, speaking as a
>>> member of the PMC, I think we should formalize this a bit more. So, I'm
>>> bringing this here.  If there are objections within 72 hrs, let's please
>>> use this template structure.
>>>
>>> A Fineract-SIP should have the following things:
>>>
>>> *Title: Specific Idea*
>>>
>>> *Summary*
>>>      the TL;DR
>>>
>>> *Status*:  Under Discussion, Proposed, VOTE, Accepted/Rejected, Under
>>> Development, Stalled, Completed
>>>        NOTE:  This is per our normal process of Discussion, Proposal,
>>> Vote and then takes it to the next step of tracking the SIP over time.
>>>
>>> *Who is involved*:   Owner and collaborators
>>>
>>> *Background/Motivation*
>>>       NOTE:  Why are we considering this?
>>>
>>> *Goals and Exclusions*
>>>      NOTE:  List high level goals and also things this will NOT address.
>>>
>>>
>>> *Change Proposed*
>>> examples.... and be specific
>>>     Architectural changes
>>>     Significant re-factoring
>>>     Test Framework
>>>     API versioning
>>>
>>> *Alternatives Considered*
>>>     Note: Why this specific approach to the challenge.
>>>
>>> *Phases of work*
>>>     Note:  Specific timelines or "gates".   We do this, learn that, then
>>> proceed.
>>>
>>> Examples from other Apache projects.
>>> https://spark.apache.org/improvement-proposals.html
>>>
>>> https://cwiki.apache.org/confluence/display/KAFKA/Kafka%20Improvement%20Proposals
>>>
>>> https://cwiki.apache.org/confluence/display/BEAM/Beam+Improvement+Proposals
>>> https://github.com/apache/pulsar/blob/master/pip/README.md
>>>
>>> - jdailey
>>>
>>

Re: Significant Improvement Proposals (SIP) TEMPLATE

Posted by Aleksandar Vidakovic <ch...@monkeysintown.com>.
+1

Note: there is at least one example based on our previous discussions in
Jira https://issues.apache.org/jira/browse/FINERACT-1908

On Mon, May 13, 2024 at 8:51 AM John Gathogo <jo...@fiter.io> wrote:

> In support of this.
>
> On Fri, May 10, 2024 at 7:56 PM James Dailey <jd...@apache.org> wrote:
>
>> Community -
>>
>> In other Apache Top Level Projects there is the notion of a SIP
>> (Significant Improvement Proposal).  The SIP is intended to signal that
>> "hey, pay attention, this is important".  It does not apply to small code
>> changes, or to features, but rather to architecture or testing frameworks,
>> or significant efforts to be undertaken.
>>
>> We've had something like that at Apache Fineract(R) but, speaking as a
>> member of the PMC, I think we should formalize this a bit more. So, I'm
>> bringing this here.  If there are objections within 72 hrs, let's please
>> use this template structure.
>>
>> A Fineract-SIP should have the following things:
>>
>> *Title: Specific Idea*
>>
>> *Summary*
>>      the TL;DR
>>
>> *Status*:  Under Discussion, Proposed, VOTE, Accepted/Rejected, Under
>> Development, Stalled, Completed
>>        NOTE:  This is per our normal process of Discussion, Proposal,
>> Vote and then takes it to the next step of tracking the SIP over time.
>>
>> *Who is involved*:   Owner and collaborators
>>
>> *Background/Motivation*
>>       NOTE:  Why are we considering this?
>>
>> *Goals and Exclusions*
>>      NOTE:  List high level goals and also things this will NOT address.
>>
>> *Change Proposed*
>> examples.... and be specific
>>     Architectural changes
>>     Significant re-factoring
>>     Test Framework
>>     API versioning
>>
>> *Alternatives Considered*
>>     Note: Why this specific approach to the challenge.
>>
>> *Phases of work*
>>     Note:  Specific timelines or "gates".   We do this, learn that, then
>> proceed.
>>
>> Examples from other Apache projects.
>> https://spark.apache.org/improvement-proposals.html
>>
>> https://cwiki.apache.org/confluence/display/KAFKA/Kafka%20Improvement%20Proposals
>>
>> https://cwiki.apache.org/confluence/display/BEAM/Beam+Improvement+Proposals
>> https://github.com/apache/pulsar/blob/master/pip/README.md
>>
>> - jdailey
>>
>

Re: Significant Improvement Proposals (SIP) TEMPLATE

Posted by John Gathogo <jo...@fiter.io>.
In support of this.

On Fri, May 10, 2024 at 7:56 PM James Dailey <jd...@apache.org> wrote:

> Community -
>
> In other Apache Top Level Projects there is the notion of a SIP
> (Significant Improvement Proposal).  The SIP is intended to signal that
> "hey, pay attention, this is important".  It does not apply to small code
> changes, or to features, but rather to architecture or testing frameworks,
> or significant efforts to be undertaken.
>
> We've had something like that at Apache Fineract(R) but, speaking as a
> member of the PMC, I think we should formalize this a bit more. So, I'm
> bringing this here.  If there are objections within 72 hrs, let's please
> use this template structure.
>
> A Fineract-SIP should have the following things:
>
> *Title: Specific Idea*
>
> *Summary*
>      the TL;DR
>
> *Status*:  Under Discussion, Proposed, VOTE, Accepted/Rejected, Under
> Development, Stalled, Completed
>        NOTE:  This is per our normal process of Discussion, Proposal, Vote
> and then takes it to the next step of tracking the SIP over time.
>
> *Who is involved*:   Owner and collaborators
>
> *Background/Motivation*
>       NOTE:  Why are we considering this?
>
> *Goals and Exclusions*
>      NOTE:  List high level goals and also things this will NOT address.
>
> *Change Proposed*
> examples.... and be specific
>     Architectural changes
>     Significant re-factoring
>     Test Framework
>     API versioning
>
> *Alternatives Considered*
>     Note: Why this specific approach to the challenge.
>
> *Phases of work*
>     Note:  Specific timelines or "gates".   We do this, learn that, then
> proceed.
>
> Examples from other Apache projects.
> https://spark.apache.org/improvement-proposals.html
>
> https://cwiki.apache.org/confluence/display/KAFKA/Kafka%20Improvement%20Proposals
> https://cwiki.apache.org/confluence/display/BEAM/Beam+Improvement+Proposals
> https://github.com/apache/pulsar/blob/master/pip/README.md
>
> - jdailey
>