Skip to content

Checklist

Christina Kang - MSFT edited this page Mar 10, 2018 · 19 revisions

This checklist comprises of things to check before submitting a pull request:

Documentation

  • Ensure that the PR has a descriptive summary.
  • Update the <root>\CODEOWNERS file as appropriate. Instruction for how to add is included in the file itself.
  • Update the <root>\src\README.rst file to summarize the changes included in the pull request. If required by semantic versioning, include change logs under a new version. Include the PR number at the end of each entry, with format New feature (#70) where 70 is the pull request number.
  • For each new command added, make sure appropriate documentation is added to the corresponding help file.

Testing

  • Any new functionality should include testing. Tests which require a live cluster connection are optional, and should be avoided if possible. Non live testing is required. Suggested testing includes unit testing, as well as paths generation test, which can be found in <root>\src\sfctl\tests\request_generation_test.py.
  • Any new commands, command groups, or commands whose names have been changed should include a test in the <root>\src\sfctl\tests\request_generation_test.py to ensure that the help text is being displayed.
  • Make sure that all test assert calls include an explanatory message for ease of debugging errors.

Conventions

Clone this wiki locally