Skip to content

Latest commit

 

History

History
50 lines (33 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 2.35 KB
Raw

About contributing

There are multiple ways you can contribute to this project.

The easiest way to contribute is to report possible bugs, request features, discuss ideas and share excitement about this project.

You can also make pull requests.

There are some best practices that will be followed during the development of this project for common good (Gitflow branching model)

So what does this mean in practice:

  • Please target your PR to develop branch
  • If you want to make a bigger contribution to the project, please open an issue first so we can plan that work, discuss the architecture and brainstorm around that idea first.

Submitting a Pull Request

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

To be able to run ./scripts/all-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