1 Star 1 Fork 1

sniper15 / precision-converters-firmware

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
CONTRIBUTING.md 1.27 KB
一键复制 编辑 原始数据 按行查看 历史
Philip Molloy 提交于 2023-09-12 11:43 . CONTRIBUTING: initial documentation

When contributing to Precision Converters Firmware please consider the following checklist:

  • Copyright header has been added to source and header files

  • Artistic Style (astyle) has been run to lint new code

    astyle --options=../no-OS/ci/astyle_config \
           projects/foobar/app/*.c \
           projects/foobar/app/*.h
  • Add EEPROM validation code

  • Add all context attributes (e.g. fw_version, hw_carrier, hw_mezzanine, hw_name, hw_mezzanine_status)

  • IIO attributes in the firmware match the corresponding Linux driver attributes

  • Create a readme.md in the project directory explaining how to use the project

  • Validate EEPROM detection and context attributes creation using IIO clients (e.g. ACE, IIO Oscilloscope)

  • Capture and verify ADC data using an IIO client

  • Test on the target platform with USE_SDRAM and NO_SDRAM where applicable

  • Test on the target platform with physical and virtual serial ports where applicable

  • Test using the STM32 HAL where applicable

  • Validate attributes, calibration, temperature sensing, etc using a client

  • Update corresponding ADI Wiki pages

  • Request links to those pages on the product page

  • Open a pull request on Github

1
https://gitee.com/sniper15/precision-converters-firmware.git
git@gitee.com:sniper15/precision-converters-firmware.git
sniper15
precision-converters-firmware
precision-converters-firmware
main

搜索帮助

53164aa7 5694891 3bd8fe86 5694891