Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
72 lines (49 loc) · 2.5 KB

CONTRIBUTING.md

File metadata and controls

72 lines (49 loc) · 2.5 KB

Contributing

First, thanks for taking the time to submit a pull request! These are the few notes and guidelines to keep things coherent.

Overview

  1. Read and abide by the Code of Conduct.
  2. Fork the project and clone.
  3. Check you have all requirements in place.
  4. Create your feature branch.
  5. Install the project dependencies for development.
  6. Test.
  7. If you have more than trivial changes (e.g. fixing typo's), then you must include a description in the CHANGELOG.md.
  8. Push your branch and submit a Pull Request.

We will review the changes as soon as possible.

Requirements

Feature Branch

Please use a descriptive and concise name for your feature branch. Below is a snippet to show how to create a branch with git.

git checkout -b feature/feature-name

Install

After installing Xcode, Bundler, and SwiftLint run the following terminal command from the project folder to install the remaining gems to be able to run all the tests and scripts as you would on the CI:

bundle install

Test

You can quickly run the test suite using Fastlane. From the project directly, use the following terminal command:

bundle exec fastlane test

Alternatively, you can run individual tests or the suite from within Xcode.

Release

To bump the version numbers, create the git tag, and create a GitHub release, run (replacing $NEW_VERSION with the desired new version number):

bundle exec fastlane bump_version version:$NEW_VERSION

Then update the latest release with notes on GitHub.

Lastly, submit the updated podspec to CocoaPods for release.