Sha256: 0f765a088f4d5f0abd639d358a48b999777d3f548c5c7111f72ef9c2f4552628

Contents?: true

Size: 1.07 KB

Versions: 70

Compression:

Stored size: 1.07 KB

Contents

# Versioning Policy

* CLI interface: Adding options is a non-breaking change, and would warrant an update of the minor version. Removing options is a breaking change and requires a major version update (we did this going to Reek 2). Adding a report format probably also warrents a minor version upgrade.
* API: We haven't really defined a 'public' API for using Reek programmatically, and we've only just started testing it. So, this is basically a blank slate at the moment. We will work on this as a part of the Reek 3 release.
* List of detected smells: Adding a smell warrants a minor release, removing a smell is a breaking change. This makes sense if you consider that the CLI allows running a single smell detector.
* Consistency of detected smells: This is very hard to guarantee. If we fix a bug in one of the detectors, some fragrant code may become smelly, or vice versa. Right now we don't bother with this.
* Smell configuration: The detectors are quite tolerant regarding configuration options that they don't recognize, so we regard any change here as only requiring a minor release.

Version data entries

70 entries across 68 versions & 2 rubygems

Version Path
reek-6.0.3 docs/Versioning-Policy.md
reek-6.0.2 docs/Versioning-Policy.md
reek-6.0.1 docs/Versioning-Policy.md
reek-6.0.0 docs/Versioning-Policy.md
reek-5.6.0 docs/Versioning-Policy.md
reek-5.5.0 docs/Versioning-Policy.md
reek-5.4.1 docs/Versioning-Policy.md
reek-5.4.0 docs/Versioning-Policy.md
reek-5.3.2 docs/Versioning-Policy.md
reek-5.3.1 docs/Versioning-Policy.md
reek-5.3.0 docs/Versioning-Policy.md
config_gems_initialization_aim-0.1.4 vendor/bundle/ruby/2.5.0/gems/config_gems_initialization_aim-0.1.1/vendor/bundle/ruby/2.5.0/gems/reek-5.2.0/docs/Versioning-Policy.md
config_gems_initialization_aim-0.1.4 vendor/bundle/ruby/2.5.0/gems/reek-5.2.0/docs/Versioning-Policy.md
config_gems_initialization_aim-0.1.3 vendor/bundle/ruby/2.5.0/gems/config_gems_initialization_aim-0.1.1/vendor/bundle/ruby/2.5.0/gems/reek-5.2.0/docs/Versioning-Policy.md
config_gems_initialization_aim-0.1.3 vendor/bundle/ruby/2.5.0/gems/reek-5.2.0/docs/Versioning-Policy.md
reek-5.2.0 docs/Versioning-Policy.md
reek-5.1.0 docs/Versioning-Policy.md
reek-5.0.2 docs/Versioning-Policy.md
reek-5.0.1 docs/Versioning-Policy.md
reek-5.0.0 docs/Versioning-Policy.md