NOTES.md

Developer's Notes

Pre-release checklist

• Generate version number and change log for new release (by running prerelease_ops.sh)
• Bump fallback version number (by running autoinc_version.sh) in:
  • monitor.hpp
  • __init__.py
  • Conda recipe
  • Conda recipe cross-platform
  • RTD version switcher
  • RTD announcement banner
• Check agreement amongst read-me pages:
  • repo read-me
  • PyPI read-me
  • ReadtheDocs homepage
• Check agreement between installation instructions:
  • repo read-me
  • PyPI read-me
  • ReadtheDocs
• Check agreement between release notes:
  • change-log
  • release history

Code tags

• The following code tags are in use:

  • 'NOTE', 'STYLE';
  • 'CAVEAT';
  • 'RFE', 'FUTURE';
  • 'TODO'.

• The following code tags are available for use:

  • 'WARNING';
  • 'HACK';
  • 'FIXME', 'QUEST'.