Skip to content

Latest commit

 

History

History
43 lines (28 loc) · 2.24 KB

CONTRIBUTORS-GUIDE.md

File metadata and controls

43 lines (28 loc) · 2.24 KB
Raw

Contributing to the Split JavaScript SDK Commons

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

Development

Development process

  1. Fork the repository and create a topic branch from development branch. Please use a descriptive name for your branch.
  2. While developing, use descriptive messages in your commits. Avoid short or meaningless sentences like: "fix bug".
  3. Make sure to add tests for both positive and negative cases.
  4. Run the linter script of the project and fix any issues you find.
  5. Run the build script and make sure it runs with no errors.
  6. Run all tests and make sure there are no failures.
  7. git push your changes to GitHub within your topic branch.
  8. Open a Pull Request(PR) from your forked repo and into the development branch of the original repository.
  9. When creating your PR, please fill out all the fields of the PR template, as applicable, for the project.
  10. Check for conflicts once the pull request is created to make sure your PR can be merged cleanly into development.
  11. Keep an eye out for any feedback or comments from Split's SDK team.

Building the SDK

For widespread reuse of the library over different SDKs with different environments and module formats, we have two different builds:

  • A ES2015 modules compatible build (located in /esm folder).
  • A CommonJS modules compatible build (located in /cjs folder).

The different builds can be generated all at once with the command npm run build. Refer to package.json for more insight on the build scripts.

Running tests

The project includes unit as well as integration tests for browser environments.

All tests can be run at once with the command npm run test.

For additional testing scripts or to get more insight on how these work, please refer to our package.json file.

Linting and other useful checks

Consider running the linter and type check script (npm run check) and fixing any issues before pushing your changes.

Contact

If you have any other questions or need to contact us directly in a private manner send us a note at [email protected]