diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f77cddcd..2fe75aca 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,11 +5,19 @@ Please note we have a [Code of Conduct](CODE_OF_CONDUCT.md), please follow it in We release new versions of this project (maintenance/features) on a monthly cadence so please be aware that some items will not get released right away. +# Testing Environment + +To do testing you need to have redis installed on your machine. Have docker installed and run the following command to start a redis container: + +```bash +pnpm test:services:start +``` + # Pull Request Process You can contribute changes to this repo by opening a pull request: 1) After forking this repository to your Git account, make the proposed changes on your forked branch. -2) Run tests and linting locally by running `yarn && yarn test`. +2) Run tests and linting locally by running `pnpm i && pnpm test`. 3) Commit your changes and push them to your forked repository. 4) Navigate to the main `cacheable` repository and select the *Pull Requests* tab. 5) Click the *New pull request* button, then select the option "Compare across forks" diff --git a/packages/cache-manager/package.json b/packages/cache-manager/package.json index 3358781d..c403b868 100644 --- a/packages/cache-manager/package.json +++ b/packages/cache-manager/package.json @@ -60,14 +60,14 @@ "keyv": "^5.1.0" }, "devDependencies": { - "@faker-js/faker": "^9.0.3", + "@faker-js/faker": "^9.1.0", "@keyv/redis": "^3.0.1", - "@types/node": "^22.7.5", + "@types/node": "^22.8.1", "@vitest/coverage-v8": "^2.1.3", "cache-manager-redis-yet": "^5.1.5", "cacheable": "^1.8.0", "rimraf": "^6.0.1", - "tsup": "^8.3.0", + "tsup": "^8.3.5", "typescript": "^5.6.3", "vitest": "^2.1.3", "xo": "^0.59.3"