We want to make contributing to this project as easy and transparent as possible, and actively welcome your pull requests. If you run into problems, please open an issue on GitHub.
- Fork the repo and create your branch from
develop. - Run the setup script
./scripts/setup.sh - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints (see below).
- Tag @yusuftor, @jakemor, and @anglinb in the pull request.
- Add an entry to the CHANGELOG.md for any breaking changes, enhancements, or bug fixes.
- After the PR is merged, delete the branch.
In Xcode, you'll need to set your indentation spacing to 2 spaces. You can do that by going to Xcode ▸ Preferences..., then choose the Text Editing tab. Inside the Display tab, set Indent wrapped lines by: to 2 spaces:
In the Editing tab, select Automatically trim trailing whitespace:
In the Indentation tab, set Tab Width and Indent Width to 2 spaces:
To maintain readability and achieve code consistency, we follow the Raywenderlich Swift Style Guide. We use SwiftLint to check for style errors.
To do this locally, you can run swiftlint from the root folder.
Unfortunately, SwiftLint can't be run on build in Xcode for Swift Packages, so we use GitHub actions instead. Every time a commit that has a change in swift code is pushed to GitHub, a GitHub Action automatically runs SwiftLint. Warnings and errors will show up as Annotations under the GitHub Action telling you what needs to change. Please fix these linting issues before creating a pull request.
Public classes and methods must contain detailed documentation.
All documentation is compiled using DocC and hosted on GitHub-Pages. This is then accessible via our iOS SDK documentation. You can also view this in Xcode by selecting Product ▸ Build Documentation.
Open the workspace from: .swiftpm/xcode/package.xcworkspace.
If you are editing one the example apps, open the example app's xcodeproj directly. The advantage of this is that you can see linting issues on build.
We have two branches: master and develop.
All pull requests are set to merge into develop, with the exception of a hotfix on master.
Name your branch feature/<feature name> for consistency.
When we're ready to cut a new release, we update the sdkVersion in Constants.swift and merge develop into master. This runs some GitHub actions to tag the release, build the docs, and push to cocoapods.
If you add new code, please make sure it gets tested! When fixing bugs, try to reproduce the bug in a unit test and then fix the test. This makes sure we never regress that issue again. Before creating a pull request, run all unit tests by pressing Cmd + U. Make sure they all pass and fix any broken tests. We also have a GitHub Action that runs the tests on push.
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue.
By contributing to SuperwallKit, you agree that your contributions will be licensed under the LICENSE file in the root directory of this source tree.