Welcome to the RN Benchmarking Repository! We appreciate your interest in contributing. This document outlines how you can get involved and contribute to this project.
The RN Benchmarking Repository is a project aimed at benchmarking the performance of rendering views, text, images, and other components for react native. By contributing to this project, you'll help us gather data and insights on the performance characteristics of react native across different scenarios and configurations.
If you encounter any bugs or issues while using the benchmarking tools or analyzing the results, please open a new issue in this repository. When reporting a bug, please provide as much information as possible, including:
- A detailed description of the issue
- Steps to reproduce the issue
- Expected behavior
- Any relevant error messages or screenshots
If you'd like to contribute code to the project by fixing existing issues or adding new features, you can do so by submitting a pull request. Please follow these steps to ensure a smooth contribution process:
Fork the Repository: Start by forking the repository to your own GitHub account.
Validate Changes Locally: Clone your forked repository and make the necessary changes. Validate your changes locally to ensure they work as intended.
Create a Pull Request: Once you've validated your changes, create a pull request from your forked repository to the original repository. Submitted pull request can be found here.
When raising the pull request, please provide the following information if possible:
- A detailed description of the fix/feature.
- How the fix/feature can improve current functionality.
Please note that we do not allow creating pull requests directly from the original repository. Always create pull requests from your forked repository.
Currently this repository only holds information around benchmarking of N rendered views, texts & images. If you have benchmarked the new react-native version against mentioned scenarios either by upgrading react-native versions in existing project, by using existing tool or in freshly crafted react-native project please make sure to add the benchmarking numbers under Reports directory in same format as other versions. In order to make sure the versions is comparable with other versions you will also need to add the versions for which benchmarking is done under Webpage/supportedVersions.json. By default if benchmarking is done using existing automation script the data will be dumped automatically in respective formats.
Also, for making the comparsion more promising we encourgage to get benchmarking numbers on same environment as we have for other versions. Older version are benchmarked on the following devices for 30 itertions:
- Android Emulator: Pixel 3A API 34
- iOS Simulator: iPhone 15 Pro (17.2)
If you want to add or would like to have benchmarking of other scenarios like time taken to make a bridge, JSI calls for respective react-native versions feel to submit a new pull request with this data or open a feature request for the same. We will more than happy to incorporate the changes so that it's available to consume on wider forums.
While adding benchmarking of new scenrios currently not available in this project it will be great addon to also add a simple webpage for quicker comparsion like we have for comparing time taken to render N views, texts & images inside Webpage directory of the project.
This project is licensed under the MIT License. By contributing to this project, you agree to license your contributions under the terms of this license.