SimpleITK/Design And Proposals: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
No edit summary
 
(12 intermediate revisions by 2 users not shown)
Line 1: Line 1:


== SimpleITK Improvement Proposals (SIPs?) ==
= SimpleITK Improvement Proposals (SIPs?) =


We wish to engage and promote the SimpleITK user community in improving, guiding and evolving SimpleITK. Additionally, we want to keep these proposed changes organized so that they can be referenced and looked upon in the future.


The SimpleITK Improvement Proposals (SIPs?) are simply wiki pages, with the proposed improvement along with sections for users to comment. The proposal should also be sent to the mailing list, so enable a discussion there. The author(s) is responsible to refining the proposal from comments on the wiki page and the mailing list. When work begins, a link to a JIRA ticket is needed on the SIP wiki page to link any resulting change.
The scope of a SIP is for an architecture change, a significant backwards compatibility change, or any improvement where additional feedback from the community is needed. Normal JIRA tickets should be used for bug fixes, standard improvements along the current design, along with feature requests.
=== [[SimpleITK/Design_And_Proposals/SIP_000 | SIP 000 ]] SimpleITK Improvement Proposals Template ===
=== [[SimpleITK/Design_And_Proposals/SIP_001 | SIP 001 ]] Refactor Superbuild for More External Projects ===
=== [[SimpleITK/Design_And_Proposals/SIP_002 | SIP 002 ]] Data Bridge for SimpleITK ===


= History =
= History =


== Advisory Review Board (ARB) ==
== Advisory Review Board (ARB) ==
The initial design of SimpleITK was done as part the the ITKv4 effort and had an [[SimpleITK/Advisory Review Board|Advisory Review Board]]. The ARB was composed of groups and individual who are potential users of the Simple ITK Layer. They provided advice to ITK developers of the simple layer regarding the design and implementation of the SimpleITK API.
The initial design of SimpleITK was done as part of the ITKv4 effort and had an [[SimpleITK/Advisory Review Board|Advisory Review Board]]. The ARB was composed of groups and individuals who are potential users of the SimpleITK layer. They provided advice to ITK developers of the simple layer regarding the design and implementation of the SimpleITK API.




Line 16: Line 24:
=== [[SimpleITK/Tcon|TCONS]] ===
=== [[SimpleITK/Tcon|TCONS]] ===


There were regular [[SimpleITK/Tcon|TCONS]] with the SimpleITK team. Now SimpleITK is discussed regularly at ITK Confab of TCON.
There were regular [[SimpleITK/Tcon|TCONS]] with the SimpleITK team. Now SimpleITK is discussed regularly at ITK Confab or TCON.

Latest revision as of 14:52, 4 February 2016

SimpleITK Improvement Proposals (SIPs?)

We wish to engage and promote the SimpleITK user community in improving, guiding and evolving SimpleITK. Additionally, we want to keep these proposed changes organized so that they can be referenced and looked upon in the future.

The SimpleITK Improvement Proposals (SIPs?) are simply wiki pages, with the proposed improvement along with sections for users to comment. The proposal should also be sent to the mailing list, so enable a discussion there. The author(s) is responsible to refining the proposal from comments on the wiki page and the mailing list. When work begins, a link to a JIRA ticket is needed on the SIP wiki page to link any resulting change.

The scope of a SIP is for an architecture change, a significant backwards compatibility change, or any improvement where additional feedback from the community is needed. Normal JIRA tickets should be used for bug fixes, standard improvements along the current design, along with feature requests.

SIP 000 SimpleITK Improvement Proposals Template

SIP 001 Refactor Superbuild for More External Projects

SIP 002 Data Bridge for SimpleITK

History

Advisory Review Board (ARB)

The initial design of SimpleITK was done as part of the ITKv4 effort and had an Advisory Review Board. The ARB was composed of groups and individuals who are potential users of the SimpleITK layer. They provided advice to ITK developers of the simple layer regarding the design and implementation of the SimpleITK API.


Survey

A Survey was conducted to aid in establishing design goals and facilitate design choices.

TCONS

There were regular TCONS with the SimpleITK team. Now SimpleITK is discussed regularly at ITK Confab or TCON.