Skip to content

Latest commit

 

History

History
58 lines (38 loc) · 1.97 KB

0000-template.md

File metadata and controls

58 lines (38 loc) · 1.97 KB
  • Start Date: (fill me in with today's date, YYYY-MM-DD)
  • RFC PR: (after opening the RFC PR, update this with a link to it and update the file name)
  • Relevant Project: (e.g. EaselJS, SoundJS, PreloadJS, TweenJS, ...)

Summary

One paragraph explanation of the feature.

Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?

Detailed design

This is the bulk of the RFC.

Explain the design in enough detail for somebody familiar with the project to understand, and for somebody familiar with the implementation to implement. This should get into specifics and corner-cases, and include examples of how the feature is used. Any new terminology should be defined here. Use definitive language, rather than proposing ideas here. The content of this RFC can be discussed and refined on GitHub. Any unanswered questions can also be written in the final 'Unresolved questions' section.

How we teach this

What names and terminology work best for these concepts and why? How is this idea best presented? As a continuation of existing patterns, or as a wholly new one?

Would the acceptance of this proposal mean the CreateJS guides must be re-organized or altered? Does it change how CreateJS is taught to new users at any level?

How should this feature be introduced and taught to existing users?

Drawbacks

Why should we not do this? Please consider the impact on teaching CreateJS, on the integration of this feature with other existing and planned features, on the impact of the API churn on existing apps, etc.

There are tradeoffs to choosing any path, please attempt to identify them here.

Alternatives

What other designs have been considered? What is the impact of not doing this?

This section could also include prior art, that is, how other frameworks in the same domain have solved this problem.

Unresolved questions

Optional, but suggested for first drafts. What parts of the design are still TBD?