This document contains information and guidelines about contributing to this project. Please read it before you start participating.
See also: Contributor Covenant Code of Conduct
You can contribute by fixing bugs or adding new features. For larger code changes, we first recommend discussing them in our Github issues. When submitting a pull request, please add relevant tests and ensure your changes don't break any existing tests (see Automated Tests below).
- Linux, Mac OS (preferred), or Windows.
- Git
- Swift
- Optional
- Xcode and CocoaPods, to test CocoaPods integration
- Node, to use helper scripts in package.json folder.
GitHub action is already setup to run tests on pull requests targeting main branch. However, to reduce heavy usage of GitHub runners, run the following commands in your terminal to test:
| Test category | With Node | Manually |
|---|---|---|
| SPM integration | Run npm run test |
Run swift test |
| CocoaPods integration (Requires Xcode) | Run npm run pod-lint |
Run pod lib lint --no-clean --allow-warnings |
By making a contribution to this project, I certify that:
- The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
- The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
- The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
- I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.