Please read this guide if you're interested in contributing to UIKit-cross-platform.
We welcome any form of contribution, especially from new members of our community 🙌
We invite you to actively participate in discussions in our Github Issues and Slack.
Click here for an invite to our Slack channel
This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
To report a bug click here.
When you're starting to look into fixing a bug, create a WIP PR that you mention in the original issue. This way, we ensure that everyone interested can share their thoughts, and duplicate work is prevented.
Adding tests is a great way to help preventing future bugs.
To request a new feature click here.
To contribute features or API changes, it's best to start a discussion in an issue first, ideally with a proposal. This allows everyone to participate and ensures that no potential implementation work is in vain.
After getting some feedback, push to your fork and submit a pull request. We may suggest some changes or improvements or alternatives, but for small changes your pull request should be accepted quickly.
Below are a series of steps to help you from a more "practical" perspective. If you need additional help concerning Git, Github has some great guides that you may want to check out! Check them out here
Fork the repo and then clone your fork
SSH:
git clone [email protected]:YOUR_USERNAME/UIKit-cross-platform.gitHTTPS:
git clone https://github.com:YOUR_USERNAME/UIKit-cross-platform.gitAdd the remote upstream
git remote add upstream git://github.com:flowkey/UIKit-cross-platform.gitFetch changes from upstream
git fetch upstreamPull changes locally
git pull upstream masterPush changes up
git push