Skip to content

v2.0.0

Choose a tag to compare

@gregswindle gregswindle released this 21 Apr 07:46
· 16 commits to master since this release
96546fe

2.0.0 (2018-04-21)

Bug Fixes

BREAKING CHANGES

  • api: two method signatures and one property name have changed.

Objects & Properties

  1. readmeInspector.ReadmeScore - refactor:rename ReadmeScore ➡️ ReadmeAppraisal
  2. module:readme-inspector/readme-score - refactor:rename 'ReadmeScore'
    module:readme-inspector/readme-appraisal 'ReadmeAppraisal', which is now
    a class.

Functions

  1. getReadmeInfo
    1.1. Function name - refactor:rename ➡️ getInfo
    1.2. Function signature - now expects a params object literal

  2. getReadmeScore
    2.1. Function name - refactor:rename ➡️ getAppraisal
    2.2. Function signature remains the same as in 1.x.x.

  3. check's signature now expects a params object literal,
    which it passes to getInfo.

API tests

Add API (integration) tests to verify appraisal initialization.

  1. Create the lib/apis/ directory
  2. Add Jest/Jasmine specs without mocks
  3. Invoke real APIs for results

CI

  1. Create four ENV variables on Appveyor.
  2. Customize greenkeeper commit messages

Documentation

  • Use commonality branding colors for 'Request a Feature' and
    'Report a Defect' badges
  • Move DEVELOPERS.md user the /docs/project/ directory
  • Add secure variables to for API testing
  • Iterate through filepaths with markdown files that require
    automated content generation