Ember Addon Essentials -- A checklist of some of the finer details to keep in mind when developing Ember addons

ember-addon-pro-tips-checklist.md

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

Proper travis.yml setup

Set proper Node Versions

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

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
• Travis Build Status
• Code Climate
• Coveralls
• Ember Observer Score
• dependencies Status
• devDependencies Status
• 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?

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