Skip to content

Latest commit

 

History

History
29 lines (15 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

29 lines (15 loc) · 1.2 KB

Contribute to Sharecord

Fork & Clone Sharecord

Tap the "Fork" button on the top of the site. After forking clone the forked repository to your Mac.

Explore Issues

Find issues from the Issues tab. If you find an issue you want to work on, please indicate it in the issue.

Getting Started

Please read the Getting Started guide in our wiki.

Pull Request

Once you are happy with your changes, submit a Pull Request.

Please provide a detailed description of your changes in your PR. If your commits contain UI changes, we ask that you provide screenshots.

Checks, Tests & Documentation

Please resolve all Violation errors in Xcode (except: TODO: warnings). Otherwise the swiftlint check on GitHub will fail.

Once you submit the PR GitHub will run a couple of actions which run tests and SwiftLint (this can take a couple of minutes). Should a test fail, it cannot be merged until tests succeed.

Make sure to resolve all merge-conflicts otherwise the PR cannot be merged.

Important: make sure your code is well documented so others can interact with your code easily!