Skip to content

Latest commit

 

History

History
71 lines (52 loc) · 1.68 KB

CONTRIBUTING.md

File metadata and controls

71 lines (52 loc) · 1.68 KB
Raw

Contributing

Thanks for helping out!

Dependencies

We have a three-way dependency scheme:

  • package.json:dependencies: Production dependencies for the archetype installed in a project.
  • dev/package.json:dependencies: Development dependencies for the archetype installed in a project.
  • package.json:devDependencies: The development dependencies used internally for the this archetype during development (self tests, checks, etc.) that are not part of the overall archeype outside workflow.

Checks, Tests

Ideally, we have CI do all this for us. For now, before opening a PR you must do all of the following steps:

Check the archetype configs:

$ gulp check

Check a fresh init'ed project:

$ npm install -g yo
$ cd /TEMP/DIR
$ yo electrode-component
(answer prompts)

$ cd NEW_PROJ
$ gulp check-cov

Documentation

To generate the usage snippet in the README.md, run:

$ gulp help

in any project where this archetype is installed and paste in the output.

Release

For tagged official releases only, make sure to:

  1. Update appropriate CHANGELOG.md notes
  2. Bump package.json version
  3. Generate a new ARCHETYPE-dev package.json
  4. Add to git, tag, and publish
$ vim CHANGELOG.md              # Version notes
$ vim package.json              # Bump version
$ gulp prepublish               # Generate `dev/package.json`
$ gulp check                    # Last check!
$ git add package.json dev CHANGELOG.md
$ git commit -m "Version bump"
$ git tag -a "vNUMBER" -m "Version NUMBER"
$ git push && git push --tags
$ npm publish                   # Publish main project
$ cd dev && npm publish         # Publish dev project