Skip to content

docs: Add paragraph explaining how to test a specific PR/commit in CO… #4743

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 20, 2025
Merged

docs: Add paragraph explaining how to test a specific PR/commit in CO… #4743

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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#<commit-hash>",
}
}
```

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.
Expand Down