Contributing to Ember

Contributing toΒ Ember

Confused about how the release process works? Curious what the heck feature flags are? Wondering which commit prefix you should use for your latest pull request? This talk answers these questions (and many more).

It includes insights into the release process, feature flagging, the build process, which commit prefixes to use, and how to create custom builds with features enabled by default.

0dfd10ad198ae5a87640da046a77a90a?s=128

Robert Jackson

March 25, 2014
Tweet

Transcript

  1. 2.

    Who the heck is this guy? β€’ Ember Release Management

    Team β€’ Frequent Ember.js Contributor β€’ General OSS addict twitter: rwjblue github: rjackson
  2. 6.

    Why is Ember Awesome? β€’ Community β€’ We need your

    ideas/contributions! β€’ Current at 330+ Contributors
  3. 7.

    Okay, how can I help? β€’ Fix / Cleanup documentation

    β€’ Report and/or Fix Bugs you Find β€’ Submit new features
  4. 10.

    Commit Prefix - Docs β€’ `[DOC] Fixed typo in blah.`

    β€’ `[DOC beta] Fixed typo in blah.` β€’ `[DOC release] Fixed typo in blah.`
  5. 12.

    Its messed up, lemme fix it β€’ Add test showing

    regression β€’ Fix issue β€’ Prefix commit
  6. 13.

    Commit Prefix - Bug-fixes β€’ `[FEATURE ember-metal-zomg] Fix blah` β€’

    `[BUGFIX beta] Fix dummy` β€’ Only severe regressions will be pulled into release channel.
  7. 14.

    Unless its a security vuln... β€’ Email security@emberjs.com β€’ Work

    with the Core Team on a fix β€’ Read the full policy at: emberjs.com/security
  8. 16.

    Huh, what are features? β€’ New API’s β€’ Backwards compat

    changes to API’s β€’ Hidden behind a feature flag
  9. 21.

    What does this mean? `true` `false` `null` Enable & remove

    flags Disable & remove Disable & leave
  10. 24.
  11. 25.

    Awesome, how do I do it? EmberENV = { FEATURES:

    { 'query-params-new': true } };
  12. 26.

    How can I contribute one? β€’ Add to features.json (null

    value) β€’ Add to FEATURES.md β€’ Hide changes behind flags β€’ Good tests (also behind flags) β€’ Prefix commit
  13. 28.

    Add to features.json β€’ Add as last line β€’ Set

    value to `null` β€’ Rebase on EVERY change
  14. 29.

    Add to FEATURES.md Add an entry with a clear description.

    Include PR link for further reading.
  15. 33.
  16. 34.
  17. 41.

    Commit Prefix - Recap [DOC channel] Message. [BUGFIX channel] Message.

    [FEATURE feature-name] [SECURITY CVE-111-1111]
  18. 43.

    [BUGFIX channel] β€’ Use for bug-fixes (duh). β€’ Target affected

    channel β€’ Only severe bugs will warrant new tag/release.