From a1dcae2ce41c7dec5f6661271ae486baa9539e0a Mon Sep 17 00:00:00 2001 From: Thibault Durand Date: Thu, 15 May 2025 14:25:49 +0200 Subject: [PATCH] docs: Add paragraph explaining how to test a specific PR/commit in CONTRIBUTING.md --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fde78af318..a4cf09cd56 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,6 +65,22 @@ After you're done, you can run `yarn example start` in the project root (or `npx To run the example on web, run `yarn example web` in the project root. +### Testing a specific pull request/commit + +If you want to test the changes brought by a pull request, you can do so by pointing at the git-commit or branch in your `package.json` file. For example: + +```json +{ + "dependencies": { + "react-native-paper": "git+https://github.com/callstack/react-native-paper.git#", + } +} +``` + +Then run `yarn install`/`npm install` in your project to install the package from the git repository. + +Alternatively, you may clone the `react-native-paper` repo and use the [yalc](https://github.com/wclr/yalc) tool to link the package to the project. + ### Working on documentation The documentation is automatically generated from the [TypeScript](https://www.typescriptlang.org/) annotations in the components. You can add comments above the type annotations to add descriptions. To preview the generated documentation, run `yarn docs start` in the project root.