# Contributing to Lib 🙏 We would ❤️ for you to contribute to Lib and help make it even better than it is today! ## Developing Start by installing all dependencies: ```bash npm i ``` Run the tests: ```bash npm test ``` Run the playground app: ```bash npm run link:start ``` Go to your dummy project in which you want to test this lib: ```bash npm link @ngneat/lib ng add @ngneat/lib @scope/libName ``` ## Building ```bash npm run build ``` ## 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 Lib 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**: ``` ():