Split SDK is an open source project and we welcome feedback and contribution. The information below describes how to build the project with your changes, run the tests, and send the Pull Request(PR).
- Fork the repository and create a topic branch from
developmentbranch. Please use a descriptive name for your branch. - While developing, use descriptive messages in your commits. Avoid short or meaningless sentences like: "fix bug".
- Make sure to add tests for both positive and negative cases.
- If your changes have any impact on the public API, make sure you update the TypeScript declaration files as well as it's related test file.
- Run the linter script of the project and fix any issues you find.
- Run the build script and make sure it runs with no errors.
- Run all tests and make sure there are no failures.
git pushyour changes to GitHub within your topic branch.- Open a Pull Request(PR) from your forked repo and into the
developmentbranch of the original repository. - When creating your PR, please fill out all the fields of the PR template, as applicable, for the project.
- Check for conflicts once the pull request is created to make sure your PR can be merged cleanly into
development. - Keep an eye out for any feedback or comments from Split's SDK team.
The build is done with the command npm run build. Refer to package.json for more insight on the build script.
All tests can be run at once with the command npm run test.
Consider running the linter and type check script (npm run check) and fixing any issues before pushing your changes.
If you want to debug your changes consuming it from a test application, you could use the React Native App example at /example folder:
cd example/
npm install
npm run android # to run in an Android emulator
npm run ios # to run on a iOS emulatorRemember to check and follow the React Native setting up guidelines before running the example.
If you have any other questions or need to contact us directly in a private manner send us a note at [email protected]