Skip to content

Latest commit

 

History

History
20 lines (14 loc) · 946 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (14 loc) · 946 Bytes

Getting started

  • Simply running npm install should get you started for development purposes
  • Use npm run lint during local development to ensure that your code will pass linting (which is also done during CI phase)
  • Ignore the last step. I don't haven't gotten to it yet.

PR guidelines

  • Every PR should have an associated issue
  • Use Angular commit message conventions
    • Allowed scopes: component, package, build. If you feel like these do not fit your use-case, consult with maintainer in PR comments section
    • Use docs(readme|demo|contrib) for corresponding changes.
  • Use closes #<Issue> statement in commit section
  • If there are changes required for your PR (or if there are merge conflicts with the target branch) - rebase and force-push instead of merging

Running demo

It's as easy as running any angular-cli app.

ng s