Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 3.26 KB

README.md

File metadata and controls

61 lines (43 loc) · 3.26 KB
Raw

Shipwright Improvement Proposals (SHIPs)

A Shipwright Improvement Proposal (SHIP) is a way to propose, communicate, and coordinate on new efforts for Shipwright.

Quick start

  1. Socialize an idea with others. Make sure others think the work is worth doing, and are willing to review design and code changes required.
  2. Draft a proposal by copying the proposal template into this directory. Name your SHIP with the file name pattern ship-NNNN-tile-name-here.md, incrementing to the next number in the sequenced of merged proposals.
  3. Submit a pull request with your proposal.

SHIP Lifecycle

  • Draft: SHIPs start their lifecycle as a pull request, copying the proposal template. They graduate to the provisional or implementable phase when the pull request is merged.
  • Provisional: SHIPs that reach this phase focus on the why. The objective is to agree that an idea addresses a need for the community. The summary, motivation, and goals should be clearly articulated. Drawbacks and alternatives may not need to be identified at this phase, though the community may ask that these be included during review. Merging a SHIP as provisional does not imply that the community will implement a feature within any reasonable timeframe.
  • Implementable: SHIPs that reach this phase focus on the how. To graduate to this phase, the proposal needs to provide details on how the feature will be implemented and any new APIs that are introduced. The proposal must also highlight the risks, drawbacks, and alternatives considered for this feature. Test and release plans do not need to be fully articulated, though the community may suggest ways to test or release the feature at this stage. Implementable proposals indicate that the community agrees to a feature and related code can be merged.
  • Implemented: SHIPs that reach this phase focus on what and when. At this point the feature may have related code pull requests that are under review or merged. Implemented proposals should have test and release plans identified. At this point the propsosal is considered "done."

Other phases in the proposal lifecycle can be:

  • Rejected: Used if a provisional or implementable proposal is later rejected by the community.
  • Withdrawn: Used if the author of a provisional or implementable proposal later withdraws it from consideration.
  • Replaced: Used if a subsequent proposal is used to implement the same set of functionality.

FAQs

Do I have to use the process?

If the enhancement has broad scope, yes. As a general rule, features that cross multiple components or introduce new APIs should have an enhancement prposal. It helps everyone track why, when, how, and by whom work is done.

Why would I want to use the process?

Provide a mechanism to communicate design and implementation strategies across the Shipwright community.

Do I need to fill out the entire template?

You do not have to complete every section of the proposal template - different sections serve different purposes in the SHIP lifecycle.

My FAQ isn't answered here!

Open an issue and ask or even better open a PR with a question and proposed answer.