Skip to content

Latest commit

 

History

History
43 lines (22 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

43 lines (22 loc) · 2.24 KB
Raw

How to contribute to Ambiot repos - ambd_arduino

Find a bug?

  • Do not open up a GitHub issue if the bug is for NDA or close source SDK, and instead to refer to NDA or close source channel.

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Update a patch that fixes a bug?

  • Open a new GitHub Pull Request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

  • Before submitting, please make sure the code is followed the mbed coding style.

Fix whitespace, format code, or make a purely cosmetic patch?

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of Ambiot will generally not be accepted.

Intend to add a new feature or change an existing one?

  • Suggest your change in the AmebaIoT Open source forum and start writing code.

  • Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.

Have questions about the source code?

Contribute to the documentation?

Ambiot is a volunteer effort. We encourage all makers to join us!

Thanks! ❤️

Realtek Singapore SD3 Team