Skip to content

Latest commit

 

History

History
79 lines (50 loc) · 3.11 KB

CONTRIBUTING.md

File metadata and controls

79 lines (50 loc) · 3.11 KB
Raw

Contributing to Cluster

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

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

Asking Questions

We don't use GitHub as a support forum. For any usage questions that are not specific to the project itself, please ask on Stack Overflow instead. By doing so, you'll be more likely to quickly solve your problem, and you'll allow anyone else with the same question to find the answer. This also allows maintainers to focus on improving the project for others.

Reporting Other Issues

A great way to contribute to the project is to send a detailed issue when you encounter a problem. We always appreciate a well-written, thorough bug report.

Check that the project issues database doesn't already include that problem or suggestion before submitting an issue. If you find a match, add a quick "+1" or "I have this problem too." Doing this helps prioritize the most common problems and requests.

Before submitting a new GitHub issue, please make sure to

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

I want to contribute to Cluster

Prerequisites

To develop Cluster, 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>/Cluster.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 Cluster. Open the Cluster.xcworkspace 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

Code of Conduct

Help us keep Cluster 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.