Skip to content

Latest commit

 

History

History
79 lines (52 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

79 lines (52 loc) · 1.82 KB
Raw

Contributing to ngx-localstorage

🙏 We would ❤️ for you to contribute to ngx-localstorage and help make it even better than it is today!

git-Workflow

This repository follows the git-flow workflow. So please make sure to create PRs only pointing to the develop branch.

Developing

Start by installing all dependencies:

npm i

Run the tests:

npm run test ngx-localstorage

Run the playground app:

ng serve

Building

ng build ngx-localstorage --prod

Coding Rules

To ensure consistency throughout the source code, keep these rules in mind as you are working:

  • All features or bug fixes must be tested by one or more specs (unit-tests).
  • All public API methods must be documented.

Commit Message Format

Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

The header is mandatory and the scope of the header is optional.

Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.

The footer should contain a closing reference to an issue if any.

Samples: (even more samples)

docs(changelog): update changelog to beta.5

fix(release): need to depend on latest rxjs and zone.js

The version in our package.json gets copied to the one we publish, and users need the latest of these.

Updating the demo

npm run build:prod