If you wish to contribute to SimpleMDM-Swift please fork the repository and send a pull request. Contributions and feature requests are always welcome, please do not hesitate to raise an issue!
Contributors and any people interacting on this project are expected to adhere to its code of conduct. See CODE_OF_CONDUCT.md for details.
To start contributing to SimpleMDM-Swift, you need the latest version of Xcode on your machine.
After cloning the project, open the Swift package in Xcode:
open /path/to/SimpleMDM-Swift/Package.swiftAll tools and non-library dependencies are listed in the Brewfile at the root of the project.
To install them, you need to have Homebrew installed on your machine, and then run:
brew bundleSome parts of this library are automatically generated using Sourcery. Run this command to regenerate code as needed:
sourceryBecause whitespace management in .stencil templates can be a bit complicated, generated code will not always follow the coding-style rules set by SwiftFormat. You should always run SwiftFormat on the generated code after running Sourcery:
# Always prefer this command combo
sourcery; swiftformat SourcesThe documentation is generated using swift-doc. To re-generate the documentation after making a change, and preview it locally use:
swift doc generate Sources --module-name SimpleMDM-Swift --format html --base-url http://localhost:9000The documentation will be generated in .build/documentation/. You will need some webserver running locally on port 9000 to view the documentation. If you have no preference, python has a built-in webserver and is shipped with macOS:
cd .build/documentation/
/usr/bin/python -m SimpleHTTPServer 9000