SmokeDetector pull request (PR) guidance

As such, a pull request that suggests code changes (NOT blacklist or watchlist changes) must have all or most of the following information:

• What does your pull request change or introduce to the project?

• What is the justification for the inclusion of your Pull Request (or, what problem does it solve?)

• Write meaningful commit messages (i.e. do not use GitHub's default "Update foo.py" commit message). A commit message must give a brief (but thorough) explanation of what your change does and why. See How to write a Git commit message. Also include a complete explanation and justification of your proposed changes in the body of your pull request.

• Include comments in your code to help guide reviewers through what you intend for the sub-portions of your code to be doing. It's a lot easier to review code when you have a general idea of what the intended functionality of a section of code is. It also helps as a double-check that the code is doing what is intended. Commenting doesn't need to be extensive, but should be present sufficiently to guide a reviewer/reader/maintainer.

• Use meaningful variable names. Variable names should reflect what the contents of that variable is, or what it represents. This helps significantly in making your code self-documenting. Using meaningful variable names can significantly reduce the need for code comments.

• What testing have you done?

• Are you relying solely on the CircleCI and Travis CI testing?

• Have you spun up a SmokeDetector instance on which you've run the code in the PR and verified that the it's actually doing what you intend/expect?