Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.38 KB
Raw

Contributing to upstash-redis-level

The following is a set of guidelines and tips for contributing to upstash-redis-level.

Getting Started

You should :fingers_crossed: be able to just run these commands. (Please make a note of any hang-ups you ran into during this process)

# check the node version, 14 or greater is required
node -v
# you can use nvm (https://github.com/nvm-sh/nvm) to switch version
# install pnpm (see docs for other options https://pnpm.io/installation)
curl -fsSL https://get.pnpm.io/install.sh | sh -
# ensure you have the latest (at the time of this writing this is 7.4.0)
pnpm -v
# install dependencies
pnpm install
# build the library
pnpm run build

Testing

SRH is used to run the tests. There is a provided docker-compose.yml to start the server. After installed Docker, you can execute docker-compose up in the project directory to start the SRH server.

You can run the tests locally by running the following command:

pnpm run test

The abstract test suite can be executed to validate the implementation:

pnpm run test:suite

NOTE: There are currently two failing tests in the suite related to this issue.