Skip to content

Maintainers Check List

Carrie Roberts edited this page Jun 10, 2021 · 17 revisions

Maintainers Check List

  1. Is the atomic in the right Technique #
  2. Is it a duplicate of an atomic that already exists
  3. Make sure Github links within commands that are executed use the permanent link if not in the redcanary repo
  4. Are input arguments used in the prereqs, commands, and cleanup commands
  5. Supported files included in /bin (for binary) or /src (for human readable)
  6. Are supported files included in the PR? Source code should be provided where custom binaries are provided (if possible)
  7. Cleanup commands are intended to remove temporary files, and reset system enough to run the test again but shouldn't remove prerequisites. Code should allow the cleanup commands to be run multiple times in a row without generating errors/warnings.
  8. Test names are descriptive. Descriptions explain what the atomic does and what success looks like. It should include links to relevant blogs and tools where applicable.
  9. Input arg defaults allow atomic to function on most systems without modification.
  10. Atomic test changes/additions are made to yaml file (and not md file since md file gets rewritten from the yaml by the Circle CI process at merge time)
Clone this wiki locally