Skip to content

contributing.md

Latest commit

 

History

History
56 lines (34 loc) · 2.71 KB

contributing.md

File metadata and controls

56 lines (34 loc) · 2.71 KB
Raw

Contributing to Fingerprint Pro Segment Source Function

Working with code

We prefer using pnpm for installing dependencies and running scripts.

You cannot push into the main branch.

We always use the main branch to create releases.

For proposing changes, use the standard pull request approach. We recommend to discuss fixes or new functionality in the Issues, first. Create pull requests into main branch.

How to build

After cloning the repo, run pnpm install to install packages.

Run pnpm build for creating a build in dist folder. After building, the dist/fingerprint-pro-segment-source-function.js file is created. This file is also used as the release artifact on GitHub.

Structure

  • src - Project source written in TypeScript
  • __tests__ - All test files

Updating Webhook Types

This project depends on the Fingerprint Webhook OpenAPI Schema. Run pnpm generateTypes to apply the latest webhook type changes.

Code style

The code style is controlled by ESLint and Prettier. Run to check that the code style is ok:

pnpm lint

You aren't required to run the check manually, the CI will do it. Run the following command to fix style issues (not all issues can be fixed automatically):

pnpm lint:fix

Commit style

Follow the conventional commits rules.

How to test

Run pnpm test to run unit and integration tests.

For running end-to-end tests locally, follow these steps:

  1. Ensure you have playwright installed
  2. Create an .env file (look at .env.example)
  3. Populate .env with required fields
  4. Run pnpm test:e2e-local

How to release a new version

The workflow release.yml is used for releasing a new version. Run it on the main branch. It uses semantic-release, so it will create a new release, generate release notes, and add the dist/fingerprint-pro-segment-source-function.js file as an artifact. As a result, the latest source function is reachable through the latest release artifact link.