Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

52 lines (34 loc) · 1.82 KB
Raw

Contributing

Pull requests are welcome!

If you encounter a problem with OneTimePassword, feel free to open an issue. If you know how to fix the bug or implement the desired feature, a pull request is even better.

A great pull request:

  • Follows the coding style and conventions of the project.
  • Adds tests to cover the added functionality or fixed bug.
  • Is accompanied by a clear explanation of its purpose.
  • Remains as simple as possible while achieving its intended goal.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Getting Started

  1. Check out the latest version of the project:
git clone https://github.com/mattrubin/OneTimePassword.git
  1. In the OneTimePassword directory, check out the project's dependencies:
cd OneTimePassword
git submodule update --init --recursive

  1. Open the OneTimePassword.xcodeproj file.

  2. Build and run the "OneTimePassword" scheme.

Managing Dependencies

OneTimePassword's source dependencies are Xcode-managed package dependencies.

Additionally, Carthage is used to manage the project's dependency on shared build configuration files. The dependent project is checked out as a submodule.

To check out the dependencies, simply follow the "Getting Started" instructions above.

To update the dependencies, modify the Cartfile and run:

carthage update --no-build --use-submodules