Thank you for participating in this project!
This document provides some basic guidelines for contributing to this repository. To propose improvements, feel free to submit a pull request or open an issue.
Before code can be accepted all contributors must read the code of conduct and complete our Individual Contributor License Agreement (CLA).
Our code of conduct applies to all platforms and venues related to this project; please follow it in all your interactions with the project and its participants.
Many great ideas for new features come from the community, and we'd be happy to consider yours!
To share your idea or request, open a GitHub Issue using the dedicated issue template.
For urgent matters (such as outages) or issues concerning the Embrace service or UI, please email support@embrace.io or reach out in our Community Slack for direct, faster assistance.
You may submit a bug report concerning the Embrace iOS SDK by opening a GitHub Issue. Use the appropriate template and provide all the listed details to help us resolve the issue.
We welcome all code contributions to the library. If you have a patch adding value to the SDK, let us know!
If you would like to contribute code you can do so through GitHub by forking the repository and sending a pull request.
Please also run and fix swiftlint by using:
$ swift run swiftlint --fix
At a minimum, to be accepted and merged, Pull Requests must:
- Have a stated goal and a detailed description of the changes made.
- Include thorough test coverage and documentation, where applicable.
- Pass all tests and code quality checks on CI.
- Receive at least one approval from a project member with push permissions.
Make sure that your code is readable, well-encapsulated, and follows existing code and naming conventions. Any suppression of lint violations must be done in code and properly explained. The PR should comprise commits that are reasonably small with proper commit messages.
You can reach us at support@embrace.io or in our Community Slack.