Skip to content

Contribution Guidelines

Jump to bottom
Alexandru Turcanu edited this page Jun 3, 2019 · 2 revisions

Contributing to PickerKit

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

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

I want to contribute to PickerKit

Prerequisites

To develop PickerKit, 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>/PickerKit.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 PickerKit. Open the PickerKit.xcodeproj workspace to start coding.

Things to keep in mind

  • Please do not change the minimum iOS version
  • 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 example project should build without warnings
  • The example project should run without issues.

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

I want to add my app to the README

If you want to add your app to the README, please do so in the "Apps Using PickerKit" section.

Add your entry in alphabetical order. You need to respect this format when writing your entry:

- [App Name as it appears on the App Store](app store link)

Make sure you are using the "geo.itunes.apple.com" domain in your link. We won't accept submissions with a description or multiple links.

Code of Conduct

Help us keep PickerKit 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 BulletinBoard guides.

Clone this wiki locally