Reviewing Changes

This doc covers the general steps to take when reviewing changes to the documentation.

There is a PULL_REQUEST_TEMPLATE

In each directory that is put in the comment section of each opened pull request.

Make sure that the changes are live

• Compare the 'Files Changed' tab to what is actually generated. Be sure to check how every changed file appears in the preview link.
  • If the preview link isn't working, pull down the changes locally and run the page to see how the page looks locally.
• Click any links to make sure they're linked correctly.
• Ensure that any files committed were meant to be committed.

Make sure any code is runnable and consistent

• Go through check the code for any common typos:
  • Missing " (quotes) around strings
  • Missing , within JSON blocks or anywhere else
  • Lines end with ; when needed
• If you're unsure if the code will run, copy/paste into a file and try to launch it. It should run without syntax errors.
• Be sure that different phone numbers are used in the to and from fields in examples. Unless intentionally sending a message or call to itself.
• Be sure that any hard-coded phone numbers are consistent throughout an entire example

General Review

• Read and re-read the content to ensure it flows well.
• Ensure that ANY links are relative within the docs site. Only use full links https://dev.bandwidth.com/..../.../ when absolutely necessary (linking from one doc site to another)
  • Ideally, everything should be linked relatively, but that is a leftover from a gitbook workaround.
• Make sure that sentences are capitalized properly