Skip to content

Commit

Permalink
docs: update CONTRIBUTION.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mistryswapnil-dream11 committed Apr 20, 2024
1 parent f7830de commit a90c959
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTION.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,20 @@ If you'd like to contribute code to the project by fixing the existing issues or
- A detailed description of the fix / feature
- How can it improve current working

### Adding benchmarking for new react-native versions

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.


## License

Expand Down

0 comments on commit a90c959

Please sign in to comment.