Contributing to Cloak Swift

If this is your first time contributing to Cloak Swift, please have a read through our Code of Conduct.

Reporting a bug

Compare the version you have installed with cloakswift version and check it against the latest version.
Check the issue hasn't already been reported.
Check there isn't already an open pull request to fix the issue.
Open an issue providing as much information as possible.
If possible, fix the bug and provide a new pull request.

Suggesting a new feature

Check the feature hasn't already been requested.
Check there isn't already an open pull request implementing a similar idea.
Open an issue providing a detailed description of the new feature, why you think it is needed and how it will be useful to other users.
If it makes sense for the feature to be added, a pull request adding the feature would be very much appreciated.

Developing

Ensure you have the latest version of Swift installed, the easiest way is via Xcode.
Clone the repository.
Ensure you have required CLI tools: mise install.
To build: build in Xcode or run swift build.
To test: test in Xcode or run swift test.
To format code: mise r format.
To lint code: mise r lint.
To run locally, navigate to the project you want to run on and then run /path/to/cloakswift {COMMAND}.

Thanks!