From 0593a39491986f631cb3a793f3705347889a5ce2 Mon Sep 17 00:00:00 2001 From: Jeremy Shipman Date: Fri, 13 Mar 2020 22:40:13 +1300 Subject: [PATCH 1/2] WIP consortium first draft --- Consortium.md | 51 ++++++++++++++++++++++++++++++ text/0000-consortium.md | 69 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 120 insertions(+) create mode 100644 Consortium.md create mode 100644 text/0000-consortium.md diff --git a/Consortium.md b/Consortium.md new file mode 100644 index 0000000..191886c --- /dev/null +++ b/Consortium.md @@ -0,0 +1,51 @@ +# CreateJS Consortium + +The GSkinner team is handing the CreateJS project over to the community. + +A plan needs to be made clear to give confidence that this is a wise decision. + +This document describes actions that need to be taken in order for confidence to be had in the community-driven effort. + +## Vision + +> What is is this project's vision? + +## Project Principles + +* *Let humans and machines each do what they are good at*. For example, humans can make high level design decisions, and machines can build and release a version of the project. +* Protect stability, performance + +## Community + +Anyone can submit a pull request for a change. +PRs are automatically checked via automated build, and bots. + +## Core team + +The core team are trusted to represent the interests of the whole. + +Only they can merge PRs, and approve high-level decisions. + +Responsible community members will agree to uphold the chosen standards of the project. + +They will be responsible for reviewing and approving code changes, ensuring they take adequate time to understand the change. + +They uphold the project code of conduct. + +### Core team onboarding + + +## Practices + +* Test coverage can only ever increase. +* Peer review of code - approved by 2 or more core developers, other than the submitter. +* Follow semantic versioning. +* Provide backwards compatibility for as long as possible. Deprecate code, and pull it out only when major version change (such as 2.x.x -> 3.0.0) + +* Stale bot to close issues if contributor is being waited on + +## Questions + +Answer these questions, as checklist items above. + +* How do we ensure change log is always updated? diff --git a/text/0000-consortium.md b/text/0000-consortium.md new file mode 100644 index 0000000..1974f42 --- /dev/null +++ b/text/0000-consortium.md @@ -0,0 +1,69 @@ +- 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, ...) + +# CreateJS Consortium + +## Summary + +Set up a consortium process/team to run the CreateJS project. + +## Motivation + +The GSkinner team is handing the CreateJS project over to the community. +CreateJS will not live unless people actively maintain the project. A plan needs to be made clear to give them confidence that this is a wise decision. + +This process was initially started here: +https://github.com/CreateJS/EaselJS/issues/1040 + +## 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. + +### Mission statement + +> What is is this project's mission statement + +> https://producingoss.com/en/getting-started.html#mission-statement + +## 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? + +## Research + +https://producingoss.com +https://guides.github.com \ No newline at end of file From 82849c8e4439c5939306f0edbd347a0f767d2a92 Mon Sep 17 00:00:00 2001 From: Jeremy Shipman Date: Wed, 1 Apr 2020 22:32:42 +1300 Subject: [PATCH 2/2] Update Consortium.md --- Consortium.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Consortium.md b/Consortium.md index 191886c..ea70cf2 100644 --- a/Consortium.md +++ b/Consortium.md @@ -1,6 +1,6 @@ # CreateJS Consortium -The GSkinner team is handing the CreateJS project over to the community. +The GSkinner team is encouraging the community to get involved in in the maintenance and direction of CreateJS. A plan needs to be made clear to give confidence that this is a wise decision.