Skip to content

Latest commit

 

History

History
46 lines (25 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

46 lines (25 loc) · 2.12 KB

Contributing to Cordux

Looking to contribute something to Cordux? Here's how you can help.

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Code of Conduct

WillowTree, Inc. has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Our Development Process

Test Suite

We run the unit test target in the latest Xcode 8.

Pull Requests

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub.

Before submitting a pull request, please make sure the following is done:

  1. Fork the repo and create your branch from develop.
  2. If you've added code that should be tested, add tests!
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.

Bugs

Where to Find Known Issues

We will be using GitHub Issues for our public bugs. We will keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn't already exist.

Reporting New Issues

The best way to get your bug fixed is to provide a reduced test case.

Style Guide

<<< OPTIONAL - Include any code conventions, documentation conventions, linter specifics, etc >>>

License

By submitting a pull request, you represent that you have the right to license your contribution to WillowTree and the community, and agree by submitting the patch that your contributions are licensed under the MIT License.