Skip to content

Commit

Permalink
CONTRIBUTING: initial documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Philip Molloy <[email protected]>
  • Loading branch information
pamolloy authored and mphalke committed Nov 30, 2023
1 parent 1484143 commit a9d5e29
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
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

0 comments on commit a9d5e29

Please sign in to comment.