Skip to content

PR checklist

Waldek Mastykarz edited this page Apr 21, 2019 · 18 revisions
  • it builds
  • all tests pass
  • 100% coverage
  • matches the spec
  • has correct name
  • has help in command
  • command class is named as follows [Service][Command]Command, eg. SpoWebRemoveCommand
  • it works
  • if command contains a parameter to specify URL, it should use getAccessToken instead of ensureAccessToken
  • command telemetry doesn't track PII
  • doesn't contain commented-out code
  • if it's a remove command, does it have a confirm option
  • doesn't retrieve form digest if not necessary
  • if the request uses json: true, failed promise is handled using handleRejectedODataJsonPromise
  • escapes user input in XML and URL
  • has relevant examples
  • examples use long names of options rather than short ones
  • it has an md help page
  • md help page is referenced in the toc
  • help in md is the same as help in the command
  • has only one commit (if not squash)