This is a set of guidelines centered around contributing to Pragmatic. Please keep these in mind when preparing or reviewing a pull request. They aren't meant to be annoying, just a baseline.
Please help us keep this community open, friendly, and inclusive by reading and following our code of conduct.
Pragmatic would not have been possible without the other excellent Xcode extensions for a jumpstart and continues to improve due to contributors such as yourself. Thank you for donating your time!
The long-term health of any project is quite important; these are a few guidelines to follow to keep ours in top shape.
All parts have been written in Swift and we'd like to continue that for the foreseeable future. If there's a compelling reason to introduce non-Swift code please bridge it appropriately and test thoroughly.
Note the number of general warnings prior to your change with a clean build. Repeat with your changes. These should be the same or less with your changes. The goal is to maintain zero build warnings.
If you cannot avoid a warning be sure to note this and the reason for it in your PR as well as with a comment in the code if possible.
Note the number of analyzer results prior to your change with a clean build. Repeat with your changes. These should be the same or less with your changes.
If you cannot avoid triggering a new result be sure to note this and the reason for it in your PR as well as with a comment in the code if possible.
Let \t be your guide. Please ensure your favorite editor is configured to respect this; Xcode can be set to use tabs (Preferences -> Editing -> Indentation) and allows you to choose how that character is displayed.