1# Redfish Checklist 2 3When making changes to the Redfish tree, please follow the checklist below. 4 5If any of these are incomplete when pushing a patch to gerrit, either mark the 6patch WIP (Work in progress), or explicitly include the items from the checklist 7that have not been completed. 8 91. Verify the documentation in Redfish.md includes all properties and schemas 10 that have been added or are used in the commit. 11 122. Document any client-facing changes in behavior in the commit message. Note, 13 that this should include behavior changes that may not affect your system. 14 153. Verify that any additional properties exist in the CSDL schema in 16 static/redfish/v1/odata. DO NOT rely solely on the JSON schema files, as they 17 are less restrictive than odata. 18 194. Document in the commit message what these property additions are used for. 20 Verify that the @odata.type on the schema on which you've added functionality 21 has a version that includes the parameters you've added 22 235. Verify that testing was performed per TESTING.md and it is documented in my 24 commit message. Redfish-Service-Validator is the MINIMUM required for any 25 Redfish change. Most changes require more tests than simply service 26 validator. If testing was performed on a previous commit in the series, but 27 not the present commit, note that explicitly with "Tested on prior commit". 28 296. Ensure that you have written unit tests for any behavior that does not have 30 external dependencies (DBus). 31 327. Read COMMON_ERRORS.md, and verify that to the best of your knowledge no 33 common errors are present in the patchset. 34 358. Verify that all DBus usages match phosphor-dbus-interfaces, or include a link 36 to the gerrit review for phosphor-dbus-interfaces in the commit message. 37