Skip to content

Instantly share code, notes, and snippets.

@BrianSipple

BrianSipple/ember-addon-essentials.md

Last active April 17, 2017 18:27
Download ZIP

Revisions

  1. Brian Sipple revised this gist Oct 6, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion ember-addon-essentials.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,6 +1,6 @@
    # Ember Addon Essentials

    This document is meant to be a brief "checklist" of things to setup for your Ember addon when beginning development in order to have the best possible architecture and workflow out of the gate. For comprehensive, reference-manual-style material, the following are bookshelf-caliber:
    This document is meant to be a brief "checklist" of things to setup for your Ember addon when beginning development in order to have the best possible architecture and workflow out of the gate. For more comprehensive material, the following are bookshelf-caliber:

    * [Ember CLI's Official Addon Guide](http://ember-cli.com/extending/#developing-addons-and-blueprints)

  2. Brian Sipple revised this gist Oct 6, 2016. 1 changed file with 11 additions and 1 deletion.
    12 changes: 11 additions & 1 deletion ember-addon-essentials.md
    View file
    Original file line number Diff line number Diff line change
    @@ -74,7 +74,17 @@ Even if your addon isn't concerned with custom blueprints, having a basic defaul
    Default blueprints are always a good idea:

    ```sh
    ember g blueprint <addon-name>
    ember g blueprint <ADDON_NAME>
    ```

    And here's all it should look like:

    ```js
    module.exports = {
    description: 'install <ADDON_NAME> into a project',
    normalizeEntityName: function() {}
    };
    ```

    ## Managing versions and publishing with `ember-release` (& and possibly git flow)
  3. Brian Sipple revised this gist Oct 6, 2016. 1 changed file with 7 additions and 3 deletions.
    10 changes: 7 additions & 3 deletions ember-addon-essentials.md
    View file
    Original file line number Diff line number Diff line change
    @@ -48,19 +48,23 @@ In `.travis.yml`:
    - EMBER_TRY_SCENARIO=ember-beta
    - EMBER_TRY_SCENARIO=ember-canary
    ```
    ## Filling out your README.md
    ## Writing a good README
    ### Badging FTW
    These are some of the badges that I've found to be the most useful when looking at a project:
    - [npm package](https://www.npmjs.com/)
    - [Travis Build Status](https://travis-ci.org/)
    - [Circle Build Status](https://circleci.com/)
    + or [Travis Build Status](https://travis-ci.org/)
    - [Code Climate](https://codeclimate.com)
    - [Coveralls](https://coveralls.io/)
    - [Ember Observer Score](https://emberobserver.com/)
    - [`dependencies` Status](https://david-dm.org/)
    - [`devDependencies` Status](https://david-dm.org/)
    - [License](https://github.com/blog/1530-choosing-an-open-source-license)

    Here's a Gist of [the Markdown needed to put these all together](https://gist.github.com/BrianSipple/74e0baa7e469831625ae1d6be1c11468).
    That's a lot of linking, though, so here's a [Gist of how something like this can be put together in Markdown](https://gist.github.com/BrianSipple/74e0baa7e469831625ae1d6be1c11468).


    ## Generate a [default blueprint for your addon](http://ember-cli.com/extending/#default-blueprint)
  4. Brian Sipple revised this gist Oct 6, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion ember-addon-essentials.md
    View file
    Original file line number Diff line number Diff line change
    @@ -27,7 +27,7 @@ when your addon's code is executed by its consuming project. If so, make it a `d

    ### Consider Installing and Running Chrome in CI tests

    This used to be a bit dirty, but @mike_north has created a super-useful [addon
    This used to be a bit dirty, but thankfully, [@mike_north](https://github.com/mike-north) has created a super-useful [addon
    that encapsulates CI configurations with Chrome](https://github.com/mike-north/ember-ci) in both Travis and Circle CI.

    ```sh
  5. Brian Sipple revised this gist Oct 6, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion ember-addon-essentials.md
    View file
    Original file line number Diff line number Diff line change
    @@ -16,7 +16,7 @@ Written around the Ember 2.6 era, this article takes a much deeper dive into sev
    - Are you using Ember Data? If not, it can be safely removed from `package.json` to lighten your dependency load.
    + `npm uninstall --save-dev ember-data`

    ### `dependencies` or `devDependencies`
    ### `dependencies` or `devDependencies`?

    A rule of thumb when determining whether a module should be listed under `dependencies` or `devDependencies`: Ask whether any specific code from this module will be executed
    when your addon's code is executed by its consuming project. If so, make it a `dependency`.
  6. Brian Sipple revised this gist Oct 6, 2016. 1 changed file with 56 additions and 78 deletions.
    134 changes: 56 additions & 78 deletions ember-addon-essentials.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,53 +1,45 @@
    # Ember Addon Pro-Tips
    # Ember Addon Essentials

    This document is meant to be a brief "checklist" of things to setup for your Ember addon when beginning development in order to have the best possible architecture and workflow out of the gate. For comprehensive, reference-manual-style material, the following are bookshelf-caliber:

    * [Ember CLI's Official Addon Guide](http://ember-cli.com/extending/#developing-addons-and-blueprints)
    * [Ember Addon Secrets](http://emberup.co/ember-addon-secrets/) (A much deeper look -- which this Gist inspired -- into some of the topics here)

    ## Filling out your package.json
    * [Ember Addon Secrets](http://emberup.co/ember-addon-secrets/) -
    Written around the Ember 2.6 era, this article takes a much deeper dive into several of the topics mentioned here.

    ## Filling out `package.json`

    - [Write a good description](https://docs.npmjs.com/files/package.json#description)
    - [Use helpful keywords](https://docs.npmjs.com/files/package.json#keywords)
    - [Enter proper author info](https://docs.npmjs.com/files/package.json#people-fields-author-contributors)
    - [Enter proper repo info](https://docs.npmjs.com/files/package.json#repository)
    - Are you using Ember Data? If not, it can be safely removed from `package.json` to lighten your depencency load.
    - ```npm uninstall --save-dev ember-data```
    - [Specify a author info](https://docs.npmjs.com/files/package.json#people-fields-author-contributors)
    - [Specify a repo](https://docs.npmjs.com/files/package.json#repository)
    - Are you using Ember Data? If not, it can be safely removed from `package.json` to lighten your dependency load.
    + `npm uninstall --save-dev ember-data`

    ### `dependencies` or `devDependencies`

    A rule of thumb when determining whether a module should be listed under `dependencies` or `devDependencies`: Ask whether any specific code from this module will be executed
    when your addon's code is executed by its consuming project. If so, make it a `dependency`.
    * For example, `ember-cli-mirage` runs a mock client-side server in consuming applications, and that code itself [relies on a `pretender` dependency](https://github.com/samselikoff/ember-cli-mirage/blob/51cb8466b3363b072e18290463553d8cc2e24864/package.json#L78)

    ## Filling out travis.yml
    ### [Set proper Node Versions](https://docs.travis-ci.com/user/languages/javascript-with-nodejs)
    ```yml
    node_js:
    - "0.12"
    - "4"
    - "5"
    - "6"
    ```
    These values are passed on to nvm; newer releases not shown above may be used if nvm recognizes them.

    ## Configuring CI

    ### Consider Installing and Running Chrome in CI tests
    ```yml
    sudo: required
    dist: trusty
    before_install:
    - export CHROME_BIN=/usr/bin/google-chrome
    - export DISPLAY=:99.0
    - sh -e /etc/init.d/xvfb start
    - sudo apt-get update
    - sudo apt-get install -y libappindicator1 fonts-liberation
    - wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
    - sudo dpkg -i google-chrome*.deb
    - npm config set progress false
    - npm install -g bower
    - npm install -g npm@^3

    install:
    - npm install
    - bower install

    This used to be a bit dirty, but @mike_north has created a super-useful [addon
    that encapsulates CI configurations with Chrome](https://github.com/mike-north/ember-ci) in both Travis and Circle CI.

    ```sh
    ember install ember-ci
    ```

    ## ember try
    ## ember-try

    [ember-try](https://github.com/ember-cli/ember-try)'s pre-generated setup is golden, but you might also want to include support for the current [Ember LTS release](http://emberjs.com/blog/2016/02/25/announcing-embers-first-lts.html):

    In `.travis.yml`:

    ```yml
    - EMBER_TRY_SCENARIO=default
    - EMBER_TRY_SCENARIO=ember-1.13
    @@ -57,6 +49,7 @@ In `.travis.yml`:
    - EMBER_TRY_SCENARIO=ember-canary
    ```
    ## Filling out your README.md
    ### Badging FTW
    - [npm package](https://www.npmjs.com/)
    - [Travis Build Status](https://travis-ci.org/)
    @@ -66,61 +59,46 @@ In `.travis.yml`:
    - [`dependencies` Status](https://david-dm.org/)
    - [`devDependencies` Status](https://david-dm.org/)
    - [License](https://github.com/blog/1530-choosing-an-open-source-license)
    ```

    [![Latest NPM release][npm-badge]][npm-badge-url]
    [![TravisCI Build Status][travis-badge]][travis-badge-url]
    [![Test Coverage][coveralls-badge]][coveralls-badge-url]
    [![Code Climate][codeclimate-badge]][codeclimate-badge-url]
    [![Ember Observer Score][ember-observer-badge]][ember-observer-badge-url]
    [![License][license-badge]][license-badge-url]
    [![Dependencies][dependencies-badge]][dependencies-badge-url]
    [![Dev Dependencies][devDependencies-badge]][devDependencies-badge-url]
    [npm-badge]: https://img.shields.io/npm/v/{{REPO_NAME}}.svg
    [npm-badge-url]: https://www.npmjs.com/package/{{REPO_NAME}}
    [travis-badge]: https://img.shields.io/travis/{{USER_NAME}}/{{REPO_NAME}}
    [travis-badge-url]: https://travis-ci.org/{{USER_NAME}}/{{REPO_NAME}}
    [coveralls-badge]: https://coveralls.io/repos/github/{{USER_NAME}}/{{REPO_NAME}}/badge.svg?branch=master
    [coveralls-badge-url]: https://coveralls.io/github/{{USER_NAME}}/{{REPO_NAME}}?branch=master
    [codeclimate-badge]: https://img.shields.io/codeclimate/github/{{USER_NAME}}/{{REPO_NAME}}.svg
    [codeclimate-badge-url]: https://codeclimate.com/github/{{USER_NAME}}/{{REPO_NAME}}
    [ember-observer-badge]: http://emberobserver.com/badges/{{REPO_NAME}}.svg
    [ember-observer-badge-url]: http://emberobserver.com/addons/{{REPO_NAME}}
    [license-badge]: https://img.shields.io/npm/l/{{REPO_NAME}}.svg
    [license-badge-url]: LICENSE.md
    [dependencies-badge]: https://img.shields.io/david/{{USER_NAME}}/{{REPO_NAME}}.svg
    [dependencies-badge-url]: https://david-dm.org/{{USER_NAME}}/{{REPO_NAME}}
    [devDependencies-badge]: https://img.shields.io/david/dev/{{USER_NAME}}/{{REPO_NAME}}.svg
    [devDependencies-badge-url]: https://david-dm.org/{{USER_NAME}}/{{REPO_NAME}}#info=devDependencies
    ```
    Here's a Gist of [the Markdown needed to put these all together](https://gist.github.com/BrianSipple/74e0baa7e469831625ae1d6be1c11468).

    ## Does your addon need a [customized default blueprint](http://ember-cli.com/extending/#default-blueprint)?
    ```

    ## Generate a [default blueprint for your addon](http://ember-cli.com/extending/#default-blueprint)

    Even if your addon isn't concerned with custom blueprints, having a basic default blueprint is extremely useful for `npm link`ing the addon into another project while developing it.

    Default blueprints are always a good idea:

    ```sh
    ember g blueprint <addon-name>
    ```

    ## Managing versions and publishing with `ember-release` (& and possibly git flow)
    [ember-release](https://github.com/lytics/ember-cli-release) is a tremendously useful (and built-in) tool that can be used with any particular branching philosophy -- but it gels quite nicely with [git flow](https://github.com/nvie/gitflow):
    - `git flow init`
    - [...create an awesome stuff...ready a release...](http://nvie.com/posts/a-successful-git-branching-model/)
    - bump the project version [appropriately](http://semver.org/) from your release branch

    1. `git flow init`

    2. [Create an awesome stuff and ready a release](http://nvie.com/posts/a-successful-git-branching-model/)

    3. Bump the project version ([appropriately](http://semver.org/)) from your release branch
    - `ember release` ([and its variants](https://github.com/lytics/ember-cli-release#examples))

    - PR the release branch back into master
    - `npm publish`

    - `npm publish` when CI goes green 🚀🚀🚀

    ## Creating A Demo? Deploy your dummyApp to GitHub Pages!
    - Why?
    - Supercool way to show off your addon
    - Supercool way to show off your addon
    - Use it to run acceptance tests against the current version
    - How
    - Establish a workflow for building a dummy app and pushing it to your repository's `gh-pages` branch.
    - [ember-cli-github-pages](https://github.com/poetic/ember-cli-github-pages) is your best friend.
    - [ember-cli-github-pages](https://github.com/poetic/ember-cli-github-pages) is your best friend.
    - In the `ember-addon` hash of your `package.json`, set the `demoURL` property to the hosted address
    ```
    "ember-addon": {
    "configPath": "tests/dummy/config"
    "demoURL": "{{GITHUB_PAGES_URL}}"
    }
    ```

    ```js
    "ember-addon": {
    "configPath": "tests/dummy/config"
    "demoURL": "{{GITHUB_PAGES_URL}}"
    }
    ```
  7. Brian Sipple renamed this gist Oct 6, 2016. 1 changed file with 0 additions and 0 deletions.
    0 ember-addon-pro-tips-checklist.md → ember-addon-essentials.md
    View file
    File renamed without changes.
  8. Brian Sipple revised this gist Jun 21, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,7 +1,7 @@
    # Ember Addon Pro-Tips
    This document is meant to be a brief "checklist" of things to setup for your Ember addon when beginning development in order to have the best possible architecture and workflow out of the gate. For comprehensive, reference-manual-style material, the following are bookshelf-caliber:
    * [Ember CLI's Official Addon Guide](http://ember-cli.com/extending/#developing-addons-and-blueprints)
    * [Ember Addon Secrets](http://emberup.co/ember-addon-secrets/)(A much deeper look -- which this Gist inspired -- into some of the topics here)
    * [Ember Addon Secrets](http://emberup.co/ember-addon-secrets/) (A much deeper look -- which this Gist inspired -- into some of the topics here)

    ## Filling out your package.json
    - [Write a good description](https://docs.npmjs.com/files/package.json#description)
  9. Brian Sipple revised this gist Jun 21, 2016. 1 changed file with 2 additions and 1 deletion.
    3 changes: 2 additions & 1 deletion ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,6 +1,7 @@
    # Ember Addon Pro-Tips
    This document is meant to be a "checklist" of things to setup for your Ember addon when beginning development in order to have the best possible architecture and workflow out of the gate. For comprehensive, reference-manual-style material, the following are bookshelf-caliber:
    This document is meant to be a brief "checklist" of things to setup for your Ember addon when beginning development in order to have the best possible architecture and workflow out of the gate. For comprehensive, reference-manual-style material, the following are bookshelf-caliber:
    * [Ember CLI's Official Addon Guide](http://ember-cli.com/extending/#developing-addons-and-blueprints)
    * [Ember Addon Secrets](http://emberup.co/ember-addon-secrets/)(A much deeper look -- which this Gist inspired -- into some of the topics here)

    ## Filling out your package.json
    - [Write a good description](https://docs.npmjs.com/files/package.json#description)
  10. Brian Sipple revised this gist May 24, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -3,7 +3,7 @@ This document is meant to be a "checklist" of things to setup for your Ember add
    * [Ember CLI's Official Addon Guide](http://ember-cli.com/extending/#developing-addons-and-blueprints)

    ## Filling out your package.json
    - [Make a good description](https://docs.npmjs.com/files/package.json#description)
    - [Write a good description](https://docs.npmjs.com/files/package.json#description)
    - [Use helpful keywords](https://docs.npmjs.com/files/package.json#keywords)
    - [Enter proper author info](https://docs.npmjs.com/files/package.json#people-fields-author-contributors)
    - [Enter proper repo info](https://docs.npmjs.com/files/package.json#repository)
  11. Brian Sipple revised this gist May 24, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,5 +1,5 @@
    # Ember Addon Pro-Tips
    This guide meant to be a "checklist" of things to setup for your Ember addon when beginning development in order to have the best possible architecture and workflow out of the gate. For comprehensive, reference-manual-style material, the following are bookshelf-caliber:
    This document is meant to be a "checklist" of things to setup for your Ember addon when beginning development in order to have the best possible architecture and workflow out of the gate. For comprehensive, reference-manual-style material, the following are bookshelf-caliber:
    * [Ember CLI's Official Addon Guide](http://ember-cli.com/extending/#developing-addons-and-blueprints)

    ## Filling out your package.json
  12. Brian Sipple revised this gist May 24, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,5 +1,5 @@
    # Ember Addon Pro-Tips
    This guide meant to be a "checklist" of things to setup for your Ember addon when beginning development in order to provide you with the best possible architecture and workflow out of the gate. For comprehensive, reference-manual-style material, the following are bookshelf-caliber:
    This guide meant to be a "checklist" of things to setup for your Ember addon when beginning development in order to have the best possible architecture and workflow out of the gate. For comprehensive, reference-manual-style material, the following are bookshelf-caliber:
    * [Ember CLI's Official Addon Guide](http://ember-cli.com/extending/#developing-addons-and-blueprints)

    ## Filling out your package.json
  13. Brian Sipple revised this gist May 24, 2016. 1 changed file with 32 additions and 16 deletions.
    48 changes: 32 additions & 16 deletions ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,9 +1,14 @@
    # Ember Addon Pro-Tips
    This guide meant to be a "checklist" of things to setup for your Ember addon when beginning development in order to provide you with the best possible architecture and workflow out of the gate. For comprehensive, reference-manual-style material, the following are bookshelf-caliber:
    * [Ember CLI's Official Addon Guide](http://ember-cli.com/extending/#developing-addons-and-blueprints)

    ## Filling out your package.json
    - [Make a good description](https://docs.npmjs.com/files/package.json#description)
    - [Use helpful keywords](https://docs.npmjs.com/files/package.json#keywords)
    - [Proper author info](https://docs.npmjs.com/files/package.json#people-fields-author-contributors)
    - [Proper repo info](https://docs.npmjs.com/files/package.json#repository)
    - Are you using Ember Data? If not, it can be safely removed from your `devDependencies`.
    - [Enter proper author info](https://docs.npmjs.com/files/package.json#people-fields-author-contributors)
    - [Enter proper repo info](https://docs.npmjs.com/files/package.json#repository)
    - Are you using Ember Data? If not, it can be safely removed from `package.json` to lighten your depencency load.
    - ```npm uninstall --save-dev ember-data```


    ## Filling out travis.yml
    @@ -51,7 +56,7 @@ In `.travis.yml`:
    - EMBER_TRY_SCENARIO=ember-canary
    ```
    ## Filling out your README.md
    ### Badging
    ### Badging FTW
    - [npm package](https://www.npmjs.com/)
    - [Travis Build Status](https://travis-ci.org/)
    - [Code Climate](https://codeclimate.com)
    @@ -90,20 +95,31 @@ In `.travis.yml`:
    [devDependencies-badge-url]: https://david-dm.org/{{USER_NAME}}/{{REPO_NAME}}#info=devDependencies
    ```

    ## Does it need a [customized default blueprint](http://ember-cli.com/extending/#default-blueprint)?
    ## Does your addon need a [customized default blueprint](http://ember-cli.com/extending/#default-blueprint)?
    ```
    ember g blueprint <addon-name>
    ```
    ## Using [git flow](https://github.com/nvie/gitflow)?
    - `git flow init`
    ## Managing versions and publishing with `ember-release`
    - `git flow` approach:
    - bump version from `develop` branch
    - merge back into master
    - npm publish
    ## Managing versions and publishing with `ember-release` (& and possibly git flow)
    [ember-release](https://github.com/lytics/ember-cli-release) is a tremendously useful (and built-in) tool that can be used with any particular branching philosophy -- but it gels quite nicely with [git flow](https://github.com/nvie/gitflow):
    - `git flow init`
    - [...create an awesome stuff...ready a release...](http://nvie.com/posts/a-successful-git-branching-model/)
    - bump the project version [appropriately](http://semver.org/) from your release branch
    - `ember release` ([and its variants](https://github.com/lytics/ember-cli-release#examples))
    - PR the release branch back into master
    - `npm publish`
    ## Creating A Demo? Use the dummyApp!
    - Supercool way to show off your addon
    - Use it to run acceptance tests against the current version
    - [Start here](http://emberup.co/host-addon-examples-through-github-pages/)
    ## Creating A Demo? Deploy your dummyApp to GitHub Pages!
    - Why?
    - Supercool way to show off your addon
    - Use it to run acceptance tests against the current version
    - How
    - Establish a workflow for building a dummy app and pushing it to your repository's `gh-pages` branch.
    - [ember-cli-github-pages](https://github.com/poetic/ember-cli-github-pages) is your best friend.
    - In the `ember-addon` hash of your `package.json`, set the `demoURL` property to the hosted address
    ```
    "ember-addon": {
    "configPath": "tests/dummy/config"
    "demoURL": "{{GITHUB_PAGES_URL}}"
    }
    ```
  14. Brian Sipple revised this gist May 23, 2016. 1 changed file with 2 additions and 2 deletions.
    4 changes: 2 additions & 2 deletions ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -5,8 +5,6 @@
    - [Proper repo info](https://docs.npmjs.com/files/package.json#repository)
    - Are you using Ember Data? If not, it can be safely removed from your `devDependencies`.

    ## Using git flow?
    - `git flow init`

    ## Filling out travis.yml
    ### [Set proper Node Versions](https://docs.travis-ci.com/user/languages/javascript-with-nodejs)
    @@ -96,6 +94,8 @@ In `.travis.yml`:
    ```
    ember g blueprint <addon-name>
    ```
    ## Using [git flow](https://github.com/nvie/gitflow)?
    - `git flow init`
    ## Managing versions and publishing with `ember-release`
    - `git flow` approach:
  15. Brian Sipple revised this gist May 23, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -3,7 +3,7 @@
    - [Use helpful keywords](https://docs.npmjs.com/files/package.json#keywords)
    - [Proper author info](https://docs.npmjs.com/files/package.json#people-fields-author-contributors)
    - [Proper repo info](https://docs.npmjs.com/files/package.json#repository)
    - Are you using Ember Data? If not, remove it from your `devDependencies`
    - Are you using Ember Data? If not, it can be safely removed from your `devDependencies`.

    ## Using git flow?
    - `git flow init`
  16. Brian Sipple revised this gist May 23, 2016. 1 changed file with 1 addition and 0 deletions.
    1 change: 1 addition & 0 deletions ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -3,6 +3,7 @@
    - [Use helpful keywords](https://docs.npmjs.com/files/package.json#keywords)
    - [Proper author info](https://docs.npmjs.com/files/package.json#people-fields-author-contributors)
    - [Proper repo info](https://docs.npmjs.com/files/package.json#repository)
    - Are you using Ember Data? If not, remove it from your `devDependencies`

    ## Using git flow?
    - `git flow init`
  17. Brian Sipple revised this gist May 23, 2016. No changes.
  18. Brian Sipple revised this gist May 23, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -18,7 +18,7 @@ node_js:
    ```
    These values are passed on to nvm; newer releases not shown above may be used if nvm recognizes them.
    ### Consider Install and use Chrome for CI tests
    ### Consider Installing and Running Chrome in CI tests
    ```yml
    sudo: required
    dist: trusty
  19. Brian Sipple revised this gist May 23, 2016. 1 changed file with 4 additions and 4 deletions.
    8 changes: 4 additions & 4 deletions ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,8 +1,8 @@
    ## Filling out your package.json
    - [Make a good description](https://docs.npmjs.com/files/package.json#description)
    - [Use helpful keywords](https://docs.npmjs.com/files/package.json#keywords)
    - [Proper author info](https://docs.npmjs.com/files/package.json#people-fields-author-contributors)
    - [Proper repo info](https://docs.npmjs.com/files/package.json#repository)
    - [Make a good description](https://docs.npmjs.com/files/package.json#description)
    - [Use helpful keywords](https://docs.npmjs.com/files/package.json#keywords)
    - [Proper author info](https://docs.npmjs.com/files/package.json#people-fields-author-contributors)
    - [Proper repo info](https://docs.npmjs.com/files/package.json#repository)

    ## Using git flow?
    - `git flow init`
  20. Brian Sipple revised this gist May 23, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -40,7 +40,7 @@ install:
    ```
    ## ember try
    [ember-try]'s pre-generated setup is golden, but you might also want to include support for the current [Ember LTS release](http://emberjs.com/blog/2016/02/25/announcing-embers-first-lts.html):
    [ember-try](https://github.com/ember-cli/ember-try)'s pre-generated setup is golden, but you might also want to include support for the current [Ember LTS release](http://emberjs.com/blog/2016/02/25/announcing-embers-first-lts.html):
    In `.travis.yml`:
    ```yml
  21. Brian Sipple revised this gist May 23, 2016. 1 changed file with 10 additions and 0 deletions.
    10 changes: 10 additions & 0 deletions ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -40,7 +40,17 @@ install:
    ```
    ## ember try
    [ember-try]'s pre-generated setup is golden, but you might also want to include support for the current [Ember LTS release](http://emberjs.com/blog/2016/02/25/announcing-embers-first-lts.html):
    In `.travis.yml`:
    ```yml
    - EMBER_TRY_SCENARIO=default
    - EMBER_TRY_SCENARIO=ember-1.13
    - EMBER_TRY_SCENARIO=ember-lts-2.4
    - EMBER_TRY_SCENARIO=ember-release
    - EMBER_TRY_SCENARIO=ember-beta
    - EMBER_TRY_SCENARIO=ember-canary
    ```
    ## Filling out your README.md
    ### Badging
    - [npm package](https://www.npmjs.com/)
  22. Brian Sipple revised this gist May 23, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -41,7 +41,7 @@ install:
    ## ember try
    ## README
    ## Filling out your README.md
    ### Badging
    - [npm package](https://www.npmjs.com/)
    - [Travis Build Status](https://travis-ci.org/)
  23. Brian Sipple revised this gist May 23, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -7,7 +7,7 @@
    ## Using git flow?
    - `git flow init`

    ## Proper travis.yml setup
    ## Filling out travis.yml
    ### [Set proper Node Versions](https://docs.travis-ci.com/user/languages/javascript-with-nodejs)
    ```yml
    node_js:
  24. Brian Sipple revised this gist May 23, 2016. 1 changed file with 5 additions and 5 deletions.
    10 changes: 5 additions & 5 deletions ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,8 +1,8 @@
    ## package.json
    - description
    - keywords
    - author info
    - repo info
    ## Filling out your package.json
    - [Make a good description](https://docs.npmjs.com/files/package.json#description)
    - [Use helpful keywords](https://docs.npmjs.com/files/package.json#keywords)
    - [Proper author info](https://docs.npmjs.com/files/package.json#people-fields-author-contributors)
    - [Proper repo info](https://docs.npmjs.com/files/package.json#repository)

    ## Using git flow?
    - `git flow init`
  25. Brian Sipple revised this gist May 23, 2016. 1 changed file with 11 additions and 11 deletions.
    22 changes: 11 additions & 11 deletions ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -1,14 +1,14 @@
    ### package.json
    ## package.json
    - description
    - keywords
    - author info
    - repo info

    ### Using git flow?
    ## Using git flow?
    - `git flow init`

    ### Proper travis.yml setup
    #### [Set proper Node Versions]()
    ## Proper travis.yml setup
    ### [Set proper Node Versions](https://docs.travis-ci.com/user/languages/javascript-with-nodejs)
    ```yml
    node_js:
    - "0.12"
    @@ -18,7 +18,7 @@ node_js:
    ```
    These values are passed on to nvm; newer releases not shown above may be used if nvm recognizes them.
    #### Consider Install and use Chrome for CI tests
    ### Consider Install and use Chrome for CI tests
    ```yml
    sudo: required
    dist: trusty
    @@ -39,10 +39,10 @@ install:
    - bower install
    ```
    ### ember try
    ## ember try
    ### README
    #### Badging
    ## README
    ### Badging
    - [npm package](https://www.npmjs.com/)
    - [Travis Build Status](https://travis-ci.org/)
    - [Code Climate](https://codeclimate.com)
    @@ -81,18 +81,18 @@ install:
    [devDependencies-badge-url]: https://david-dm.org/{{USER_NAME}}/{{REPO_NAME}}#info=devDependencies
    ```

    ### Does it need a [customized default blueprint](http://ember-cli.com/extending/#default-blueprint)?
    ## Does it need a [customized default blueprint](http://ember-cli.com/extending/#default-blueprint)?
    ```
    ember g blueprint <addon-name>
    ```
    ### Managing versions and publishing with `ember-release`
    ## Managing versions and publishing with `ember-release`
    - `git flow` approach:
    - bump version from `develop` branch
    - merge back into master
    - npm publish
    ### Creating A Demo? Use the dummyApp!
    ## Creating A Demo? Use the dummyApp!
    - Supercool way to show off your addon
    - Use it to run acceptance tests against the current version
    - [Start here](http://emberup.co/host-addon-examples-through-github-pages/)
  26. Brian Sipple created this gist May 23, 2016.
    98 changes: 98 additions & 0 deletions ember-addon-pro-tips-checklist.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,98 @@
    ### package.json
    - description
    - keywords
    - author info
    - repo info

    ### Using git flow?
    - `git flow init`

    ### Proper travis.yml setup
    #### [Set proper Node Versions]()
    ```yml
    node_js:
    - "0.12"
    - "4"
    - "5"
    - "6"
    ```
    These values are passed on to nvm; newer releases not shown above may be used if nvm recognizes them.
    #### Consider Install and use Chrome for CI tests
    ```yml
    sudo: required
    dist: trusty
    before_install:
    - export CHROME_BIN=/usr/bin/google-chrome
    - export DISPLAY=:99.0
    - sh -e /etc/init.d/xvfb start
    - sudo apt-get update
    - sudo apt-get install -y libappindicator1 fonts-liberation
    - wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
    - sudo dpkg -i google-chrome*.deb
    - npm config set progress false
    - npm install -g bower
    - npm install -g npm@^3

    install:
    - npm install
    - bower install
    ```
    ### ember try
    ### README
    #### Badging
    - [npm package](https://www.npmjs.com/)
    - [Travis Build Status](https://travis-ci.org/)
    - [Code Climate](https://codeclimate.com)
    - [Coveralls](https://coveralls.io/)
    - [Ember Observer Score](https://emberobserver.com/)
    - [`dependencies` Status](https://david-dm.org/)
    - [`devDependencies` Status](https://david-dm.org/)
    - [License](https://github.com/blog/1530-choosing-an-open-source-license)
    ```
    [![Latest NPM release][npm-badge]][npm-badge-url]
    [![TravisCI Build Status][travis-badge]][travis-badge-url]
    [![Test Coverage][coveralls-badge]][coveralls-badge-url]
    [![Code Climate][codeclimate-badge]][codeclimate-badge-url]
    [![Ember Observer Score][ember-observer-badge]][ember-observer-badge-url]
    [![License][license-badge]][license-badge-url]
    [![Dependencies][dependencies-badge]][dependencies-badge-url]
    [![Dev Dependencies][devDependencies-badge]][devDependencies-badge-url]
    [npm-badge]: https://img.shields.io/npm/v/{{REPO_NAME}}.svg
    [npm-badge-url]: https://www.npmjs.com/package/{{REPO_NAME}}
    [travis-badge]: https://img.shields.io/travis/{{USER_NAME}}/{{REPO_NAME}}
    [travis-badge-url]: https://travis-ci.org/{{USER_NAME}}/{{REPO_NAME}}
    [coveralls-badge]: https://coveralls.io/repos/github/{{USER_NAME}}/{{REPO_NAME}}/badge.svg?branch=master
    [coveralls-badge-url]: https://coveralls.io/github/{{USER_NAME}}/{{REPO_NAME}}?branch=master
    [codeclimate-badge]: https://img.shields.io/codeclimate/github/{{USER_NAME}}/{{REPO_NAME}}.svg
    [codeclimate-badge-url]: https://codeclimate.com/github/{{USER_NAME}}/{{REPO_NAME}}
    [ember-observer-badge]: http://emberobserver.com/badges/{{REPO_NAME}}.svg
    [ember-observer-badge-url]: http://emberobserver.com/addons/{{REPO_NAME}}
    [license-badge]: https://img.shields.io/npm/l/{{REPO_NAME}}.svg
    [license-badge-url]: LICENSE.md
    [dependencies-badge]: https://img.shields.io/david/{{USER_NAME}}/{{REPO_NAME}}.svg
    [dependencies-badge-url]: https://david-dm.org/{{USER_NAME}}/{{REPO_NAME}}
    [devDependencies-badge]: https://img.shields.io/david/dev/{{USER_NAME}}/{{REPO_NAME}}.svg
    [devDependencies-badge-url]: https://david-dm.org/{{USER_NAME}}/{{REPO_NAME}}#info=devDependencies
    ```

    ### Does it need a [customized default blueprint](http://ember-cli.com/extending/#default-blueprint)?
    ```
    ember g blueprint <addon-name>
    ```
    ### Managing versions and publishing with `ember-release`
    - `git flow` approach:
    - bump version from `develop` branch
    - merge back into master
    - npm publish
    ### Creating A Demo? Use the dummyApp!
    - Supercool way to show off your addon
    - Use it to run acceptance tests against the current version
    - [Start here](http://emberup.co/host-addon-examples-through-github-pages/)