Skip to content

Latest commit

 

History

History
74 lines (41 loc) · 2.55 KB

ISSUE_TEMPLATE.md

File metadata and controls

74 lines (41 loc) · 2.55 KB

ObjectivePHP RFC:

  • Version: 0.9
  • Date: 2013-02-24 (use today's date here)
  • Author: Your Name, [email protected]
  • Status: Draft (or Under Discussion or Accepted or Declined - please also apply matching label on issue)

This is a suggested template for ObjectivePHP Request for Comments (RFCs).

Change this template to suit your RFC. Not all RFCs need to be tightly specified.

Not all RFCs need all the sections below. Typically, the very first draft version of a RFC could contain the summary section only.

Summary

The elevator pitch for the RFC. This first section should describe the big picture of the proposal:

  • why are you thinking this would be an asset for the framework?
  • which problem does it solve?
  • and/or what feature does it provide.

Nevertheless, you're welcome to submit a complete RFC at first commit.

Proposal

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

Detailed features and examples of the proposal.

Explain here how the proposal integrates with existing components if needed.

Also explain the way you think it could be implemented.

Backward Incompatible Changes

What breaks, and what is the justification for it?

If proposal implies BC Breaks, please indicate how existing code will have to be modified to get compatible with the RFC.

Proposed ObjectivePHP Version(s)

List the proposed versions that the feature will be included in. Use relative versions such as “next 2.x” or “next 2.x.y”.

RFC Impact

To Components

Describe the impact to the core components.

To Packages

Describe the impact to the packages.

To Workflow

Describe any new workflow steps and/or steps modifications required by this proposal (if applies), so they can be accurately and comprehensively explained in the framework documentation.

To Configuration

Describe any new configuration directive so they can be accurately and comprehensively explained in the framework documentation.

Future Scope

This sections details areas where the feature might be improved in future, but that are not currently proposed in this RFC.

Proposed Voting Choices

Include these so readers know where you are heading and can discuss the proposed voting options.

State whether this project requires a 2/3 or 50%+1 majority

Links to external references, discussions, issues or RFCs