Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

44 lines (29 loc) · 2.89 KB
Raw

Contributing to SwiftyGPIO

Thank you for considering to contribute to SwiftyGPIO!

You can contribute to the development of SwiftyGPIO in various ways, reporting or resolving issues or implementing missing features and fixing bugs opening a pull request.

If you are planning to introduce a new feature or you are thinking about major modifications to the code base, please open an issue first and descrive what you want to do. This gives us time to discuss your idea and tells the community that you are working on this specific feature.

The SwiftyGPIO project makes heavy use of pointers and C interop, that are a lesser-known area of the language API, please refer to this article for everything you may want to know on how to use unsafe pointers and how to interact with libc and C modules.

If you are reporting a bug please specify which board you are using and which OS, some bugs could affect only specific boards or OS releases.

Testing SwiftyGPIO on new boards or verify that it still works on less common boards is also highly appreciated (I can't test them all). If the board you are using is not listed in the readme as supported but you've verified that SwiftyGPIO works (at least the GPIO feature), please consider opening a pull request to add the board to the readme.

If you want to include your project or a device library in the readme, just open a pull request. Building a library for a new device or sensor is another great way to contribute to the project!

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.

Developer's CoO from elinux.org