Skip to content

Latest commit

 

History

History
77 lines (51 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

77 lines (51 loc) · 1.64 KB
Raw

CONTRIBUTING

We welcome issues and pull requests from the community. 💜

Issues

Open an issue on the issue tracker.

There a few issue templates to choose from, where you will find instructions on how to report a bug or request a feature.

Pull requests

There are no strict rules for pull requests, but we recommend the following:

  • Open an issue first, and discuss your idea with the maintainers.
  • Fork the repository and create a new branch for your changes.
  • Make your changes and submit a pull request.
  • Add tests for your changes.
  • Update the documentation.

Setup

This is a standard Node.js project. You'll need to have Node.js installed.

Fork this repository, clone and install dependencies:

npm install

Running unit tests

npm test

Running integration tests

npm run build # Build the library first

cd e2e
npm install
npm run build # Record snapshots

The last command will record snapshots (fixtures) for the integration tests. Make sure they don't change unexpectedly. If there are changes, review them and re-run unit tests:

cd ..
npm test -- -u # Update snapshots

Checking your code

Before committing, run the linter and tests:

npm run lint
npm test

To create a commit, use Commitizen:

npx cz

and follow the instructions. We adhere to Angular's commit message guidelines.

Thanks in advance for your contribution!