The following is a set of guidelines for contributing to UIDefaultFont on GitHub.
Above all, thank you for your interest in the project and for taking the time to contribute! 👍
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.
To develop UIDefaultFont, you will need to use an Xcode version compatible with the Swift version specified in the README.
- Click the “Fork” button in the upper right corner of repo
- Clone your fork:
git clone https://github.com/<YOUR_GITHUB_USERNAME>/UIDefaultFont.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.
voice-over,fix-font-size, etc.
That’s it! Now you’re ready to work on UIDefaultFont. Open the UIDefaultFont.xcodeproj project to start coding.
- Please do not change the minimum iOS version
- Always document new public methods and properties
Before opening a pull request, please make sure your changes don't break things.
- The framework and example project should build without warnings
- The example project should run without issues.
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
Help us keep UIDefaultFont open and inclusive. Please read and follow our Code of Conduct.
This project is licensed under the terms of the MIT license. See the LICENSE file.
These contribution guidelines were adapted from fastlane guides.