Skip to content

Latest commit

 

History

History
56 lines (32 loc) · 2.45 KB

CONTRIBUTING.md

File metadata and controls

56 lines (32 loc) · 2.45 KB
Raw

Contributing to SwiftShortcuts

The following is a set of guidelines for contributing to SwiftShortcuts 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

This project does not come with GitHub Issues-based support, and users are instead encouraged to become active participants in its continued development — by fixing any bugs that they encounter, or by improving the documentation wherever it's found to be lacking.

If you have an issue with importing your shortcut into the Shortcuts app, feel free to open a Pull Request with a new test case.

I want to contribute to SwiftShortcuts

Prerequisites

To develop SwiftShortcuts, you will need to use either a Swift toolchain or 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>/swift-shortcuts.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 SwiftShortcuts. If using Xcode, open the Package.swift file in Xcode. Otherwise you can use your favorite text editor to start coding.

Things to keep in mind

  • Always document new public types, 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 tests should pass on both macOS and Linux

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 SwiftShortcuts 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 guidelines.