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