Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 3.62 KB

CONTRIBUTING.md

File metadata and controls

56 lines (41 loc) · 3.62 KB
Raw

Contributing to XMC for Arduino

First important point: All Contributions are welcomed 👐.

Please contribute and raise issues via the github repository

Overview for Contributors

  • Start your contribution by creating a fork of this repository
  • It's recommended to create a separate branch for your contribution in your fork
  • Once your contribution is ready & tested, please create a Pull Request to the master branch
  • Once we merged your changes to the master branch, they are automatically included in the next release

Install the BSP under development (on Windows)

Clone the repository in Arduino folder:

  • Open Arduino and install any version of this project as described here.
  • Open the installation location in your Arduino program folder, e.g. C:\Users\<username>\AppData\Local\Arduino15\packages\Infineon\hardware\xmc
  • Open git bash, type command: git clone <your-xmc-for-arduino-fork> <version>

This allows quick testing of local changes during development.

[!TIP] If you encounter strange behavior with Arduino IDE during development, try cleaning up the cache:

  • Windows: C:\User\"username"\AppData\Roaming\arduino-ide
  • Linux: ~/.config/arduino-ide
  • macOS: ~/Library/Application Support/arduino-ide/

Automated Build Checks

Currently a Github workflow is used for automatic compilation checking and releasing. Workflows are defined here. Before opening a Pull Request for your contribution, please add a git tag in the format Vx.y.z (e.g. V3.3.0) to trigger the release process in your fork and pass the compilation tests.

Creating and Maintaining Third Party Libraries

Basics

The Arduino IDE allows for external libraries to be added to support specific devices and functions which are not part of the core setup. For details on creating libraries see the Arduino library specifications. If you add additional libraries to this project, make sure to document them accordingly.

XMC-for-Arduino Configuration

To ensure that a library specific to one architecture or board type is only compiled when a supporting board is set up, this specification includes a setting for architecture in the library.properties file.

When creating or maintaining third party or external libraries for XMC-for-Arduino please use this setting:

architecture=xmc

If your library also supports other boards and architectures, add those in as well.

Validation test

To test the XMC4arduino, we used unity to test some of the features of the arduino core & builtin library.

Tests are located in tests/arduino-core-tests and included as submodule in this project. Run git submodule update --init --recursive to update them. If you are nor familiar with submodules, check out: https://git-scm.com/book/en/v2/Git-Tools-Submodules

Code checks (WIP)

Refer to libraries\CAN\Makefile.codecheck

  • Regarding formatting, we currently use pre-commit to automatically run clang-formatting to format all c/c++ code. Please install this python package, and follow the quick start (the pre-commit configuration file is already there). You should be able to format your code automatically on git commit!