Skip to content

Latest commit

 

History

History
72 lines (53 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

72 lines (53 loc) · 1.97 KB
Raw

Contributing to Akita

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

Developing

Start by installing all dependencies:

npm i

Run the tests:

npm test

Run the playground app:

cd playground
npm i
npm start

Building

npm run build

will create a build in the dist/ directory.

The playground application is linked directly to the source files, make it easy to debug the code.

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 Guidelines

We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the Akita changelog.

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.