Skip to content

Latest commit

 

History

History
49 lines (34 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 2.25 KB

How to Contribute

There are some ways you could contribute to this project:

  • Report bugs or issues.
  • Create pull requests for bug fixes or new features.

Still, there are some rules that need to be followed for contributing:

  • Use GitHub's Swift style guide for any pull request, since this project follows it.
  • Open issues for big features, so we can discuss to plan it out.
  • Use Vincent Driessen's Git branching model. This means every pull request should target the develop branch. Every feature and fixes will be merged to develop first before merged to master.
  • Make sure current tests pass for every changes, and add new tests for new features.

Submitting a Pull Request

Before submitting a pull request please make sure ./run-tests.sh is passing (exits with 0), otherwise we won't be able to pull your code.

To be able to run ./run-tests.sh, you'll need to install xcpretty:

sudo gem install xcpretty

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

  • (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or

  • (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or

  • (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

  • (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Wording of statement copied from elinux.org