To contribute code or documentation, please submit a pull request.
If you would like to implement a new sample, please raise an issue before sending a pull request so that the sample can be discussed.
To fix a bug, please raise an issue before sending a pull request so that the bug can be tracked.
Any change requires approval before it can be merged. A list of maintainers can be found on the MAINTAINERS page.
Each source file must include a license header for the Apache Software License 2.0. Using the SPDX format is the simplest approach. See existing source files for an example.
On your local machine you can lint and beautify in mostly the same way that Travis CI does.
There are two commands you can run to make sure your code meets the required standards:
make lint- Runs a linter against the code.make beautify- Runs a set of code beautifiers and does in-place code beautification.
The following dependencies are required when developing these sample apps:
- Python 3 and pip
- jq
- Make (installed on most systems by default, for windows see here)
The Python dependencies required can be installed using:
pip install -r requirements.txtPull requests will be accepted only if make lint produces no warnings or errors and make beautify results in
no code changes.