Skip to content

Commit

Permalink
docs: tweak them a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
s-h-a-d-o-w committed Aug 10, 2022
1 parent 9370427 commit 2442808
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,19 +94,21 @@ You can configure `standard-version` either by:
Any of the command line parameters accepted by `standard-version` can instead
be provided via configuration. Please refer to the [conventional-changelog-config-spec](https://github.com/conventional-changelog/conventional-changelog-config-spec/) for details on available configuration options.

As an example, suppose you're using GitLab, rather than GitHub, you might modify the following variables:
### Customizing CHANGELOG Generation

By default (as of `6.0.0`), `standard-version` uses the [conventionalcommits preset](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits).

This preset adheres closely to the [conventionalcommits.org](https://www.conventionalcommits.org) specification.

Suppose you're using GitLab, rather than GitHub, you might modify the following variables:

* `commitUrlFormat`: the URL format of commit SHAs detected in commit messages.
* `compareUrlFormat`: the URL format used to compare two tags.
* `issueUrlFormat`: the URL format used to link to issues.

Making these URLs match GitLab's format, rather than GitHub's.

### Customizing CHANGELOG Generation further

By default (as of `6.0.0`), `standard-version` uses the [conventionalcommits preset](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits).

This preset adheres closely to the [conventionalcommits.org](https://www.conventionalcommits.org) specification.
### Deeper customization

You can override both [parser](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser) and [writer](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-writer) options (they will be merged into the preset we just mentioned). As an example, to list commits in the order that they were committed:

Expand Down

0 comments on commit 2442808

Please sign in to comment.