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