Introducing Breaking Changes

process

#1

Breaking changes are changes that make an existing way of doing something (whether correct or not) invalid. This includes name changes of public methods, classes, or configurations.

Breaking changes must be identified as early as possible! If you are planning on making a breaking change, aside from discussing it here on #nupic:developers you should follow the following steps:

  1. document breaking change within commit message (which will go in CHANGELOG.md)
  2. announce the breaking change on #nupic:developers with a link to the PR that contains it
  3. allow 72 hours before merging for community response
  4. merge PR
  5. release new MINOR versions for community
  6. announce new release, including breaking change, at #nupic