Skip to content

Commit b05d484

Browse files
authored
docs: Add paragraph explaining how to test a specific PR/commit (#4743)
1 parent db7dd00 commit b05d484

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,22 @@ After you're done, you can run `yarn example start` in the project root (or `npx
6565

6666
To run the example on web, run `yarn example web` in the project root.
6767

68+
### Testing a specific pull request/commit
69+
70+
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:
71+
72+
```json
73+
{
74+
"dependencies": {
75+
"react-native-paper": "git+https://github.com/callstack/react-native-paper.git#<commit-hash>",
76+
}
77+
}
78+
```
79+
80+
Then run `yarn install`/`npm install` in your project to install the package from the git repository.
81+
82+
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.
83+
6884
### Working on documentation
6985

7086
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.

0 commit comments

Comments
 (0)