Welcome to the Speechmatics Javascript SDK! We're open to contributions from anyone. We hope you can find everything you need in here to get started contributing to this repo.
We try not to be too prescreptive about how people work, but we also believe in helping make things easier by following a couple of basic steps. If you follow these recommendations, it should make the review process simpler and quicker:
- If your change is large, consider reaching out to us beforehand and discussing the issue. This could save you a lot of time if there are good reasons why we haven't done something.
- Fork the repo and work on a branch on your fork. Try to give your branches short, descriptive names in the format {type}/{description} e.g. bugfix/missing-try-catch.
- Make sure your changes are tested - ideally both manually and in the unit tests.
- When opening a PR back into our repo, provide some simple descriptive comments that list the changes being made in the PR.
- Give your PR a short, descriptive title.
If you are experiencing a bug, you can report it via the issues page. The more details you give us, the better we can understand and fix your problem!
If you want a feature, you can open a discussion via the issues page. Try to tag your issue with the most appropriate label available so that we can track it more easily.
There is a basic level of unit test coverage in this repo. To run the tests you will need to get a Speechmatics API key. You should be able to run the tests with a free-tier account (no credit card required). The command to run the tests is:
export API_KEY=YOUR_KEY
cargo test --tests --lib --all-features