Skip to content

Instantly share code, notes, and snippets.

@nevir

nevir/notes.md

Created November 11, 2014 19:08
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save nevir/b6496718a3de4d884ba7 to your computer and use it in GitHub Desktop.
Save nevir/b6496718a3de4d884ba7 to your computer and use it in GitHub Desktop.
Download ZIP
Raw
notes.md

Notes About This Skeleton

/demo/

We move demo sources into their own folder for a couple reasons:

  • It better groups them (we should feel free to add various demos in separate files).

  • It makes it much easier to bower ignore.

  • /demo/index.html becomes the demo "root", making for more natural URLs.

  • Dependencies for the demo should be --save-dev'd to devDependencies.

/test/

Same rationale as /demo. Dependencies should also be --save-dev'd.

bower.json

  • Even though version is not honored by Bower, we include to help someone disambiguate which version they have checked out.

  • main contains all primary .html sources (i.e. element definitions). This should match the imports you declare in metadata.html.

  • authors is a handy place for us to annotate element owners.

    • The list should always include "The Polymer Authors (http://polymer.github.io/AUTHORS.txt)" to provide a common value to search for when filtering to all our projects.

  • repository is helpful metadata for anyone who is retrieving the package via some means other than bower (such as our zip).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment