Skip to content

docs(format): update example code with new report structure #465

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 11, 2018
Merged

docs(format): update example code with new report structure #465

merged 1 commit into from
Oct 11, 2018

Conversation

byCedric
Copy link
Member

@byCedric byCedric commented Oct 8, 2018

Description

The new formatters feature introduced the new report-structure. This structure is created within the CLI and passed to the formatter to produce a nice string.

Motivation and Context

I'd recon if people want to create their own formatter, they probably checkout the default @commitlint/format.

Usage examples

How Has This Been Tested?

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@marionebl marionebl merged commit 9be3501 into conventional-changelog:master Oct 11, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants