This is adapted from vue-next commit convention.

Hi! I'm really excited that you are interested in contributing to SYWebViewBridge. Before submitting your contribution, please make sure to take a moment and read through the following guidelines.

• Checkout a topic branch from a base branch, e.g. master, and merge back against that branch.

• If adding a new feature:

  • Add accompanying test case.
  • Provide a convincing reason to add this feature. Ideally, you should open a suggestion issue first and have it approved before working on it.

• If fixing a bug:

  • If you are resolving a special issue, add (fix #xxxx[,#xxxx]) (#xxxx is the issue id) in your PR title for a better release log, e.g. update async call (fix #666).
  • Provide a detailed description of the bug in the PR. Live demo preferred.
  • Add appropriate test coverage if applicable.

• It's OK to have multiple small commits as you work on the PR - GitHub can automatically squash them before merging.

• Make sure tests pass!

• Commit messages must follow the commit message convention so that changelogs can be automatically generated. Commit messages are automatically validated before commit (by invoking Git Hooks via husky).

You will need Xocde, and VSCode.

After cloning the repo, run:

A high level overview of tools used:

Unit tests are collocated with the code being tested in each package, inside directories named __tests__.

Thank you to all the people who have already contributed to SYWebViewBridge.js!

npm run docs:build