CONTRIBUTING.md

Contributing to ShortcutsSwift

The following is a set of guidelines for contributing to ShortcutsSwift on GitHub.

Above all, thank you for your interest in the project and for taking the time to contribute! 👍

I want to report a problem or ask a question

Before submitting a new GitHub issue, please make sure to

• Check out the documentation.
• Read the usage guide on the README.
• Search for existing GitHub issues.

If the above doesn't help, please submit an issue on GitHub.

I want to contribute to ShortcutsSwift

Prerequisites

To develop ShortcutsSwift, you will need to use an Xcode version compatible with the Swift version specified in the README.

Checking out the repository

• Click the “Fork” button in the upper right corner of repo
• Clone your fork:
  • git clone https://github.com/<YOUR_GITHUB_USERNAME>/shortcuts-swift.git
• Create a new branch to work on:
  • git checkout -b <YOUR_BRANCH_NAME>
  • A good name for a branch describes the thing you’ll be working on, e.g. add-action, fix-bug, etc.

That’s it! Now you’re ready to work on ShortcutsSwift. Open the ShortcutsSwift project to start coding.

Things to keep in mind

• Always document new public methods and properties

Testing your local changes

Before opening a pull request, please make sure your changes don't break things.

• The framework and tests should build without warnings
• The playground book should run without issues on iPad.

Submitting the PR

When the coding is done and you’ve finished testing your changes, you are ready to submit the PR to the main repo. Some best practices are:

• Use a descriptive title
• Link the issues that are related to your PR in the body

Code of Conduct

Help us keep ShortcutsSwift open and inclusive. Please read and follow our Code of Conduct.

License

This project is licensed under the terms of the MIT license. See the LICENSE file.

These contribution guidelines were adapted from fastlane guides.