Skip to content

Commit 8473844

Browse files
pvdlggr2m
pvdlg
authored and
gr2m
committed
docs: fix markdown style
1 parent 63675e8 commit 8473844

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

‎README.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ Additional options can be set within the plugin definition in `package.json` to
3030
}
3131
```
3232

33-
| Option | Description | Default |
34-
| -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------- |
35-
| `preset` | [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) preset (possible values: `angular`, `atom`, `codemirror`, `ember`, `eslint`, `express`, `jquery`, `jscs`, `jshint`). | `angular` |
36-
| `config` | NPM package name of a custom [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) preset. | - |
37-
| `releaseRules` | An external module, a path to a module or an `Array` of rules. See [Release rules](#release-rules). | See [Release rules](#release-rules) |
38-
| `parserOpts` | Additional [conventional-commits-parser](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser#conventionalcommitsparseroptions) options that will extends ones loaded by `preset` or `config`. See [Parser options](#parser-options). | - |
33+
| Option | Description | Default |
34+
|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------|
35+
| `preset` | [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) preset (possible values: `angular`, `atom`, `codemirror`, `ember`, `eslint`, `express`, `jquery`, `jscs`, `jshint`). | `angular` |
36+
| `config` | NPM package name of a custom [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) preset. | - |
37+
| `releaseRules` | An external module, a path to a module or an `Array` of rules. See [Release rules](#release-rules). | See [Release rules](#release-rules) |
38+
| `parserOpts` | Additional [conventional-commits-parser](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser#conventionalcommitsparseroptions) options that will extends ones loaded by `preset` or `config`. See [Parser options](#parser-options). | - |
3939

4040
**NOTE:** `config` will be overwritten by the values of `preset`. You should use either `preset` or `config`, but not both. Individual properties of `parserOpts` will overwrite ones loaded with `preset` or `config`.
4141

@@ -66,36 +66,36 @@ Each commit will be compared with each rule and when it matches, the commit will
6666
See [release types](lib/default-release-types.js) for the release types hierarchy.
6767

6868
With the previous example:
69-
* Commits with `type` 'docs' and `scope` 'README' will be associated with a `patch` release.
70-
* Commits with `type` 'refactor' and `scope` starting with 'core-' (i.e. 'core-ui', 'core-rules', ...) will be associated with a `minor` release.
71-
* Other commits with `type` 'refactor' (without `scope` or with a `scope` not matching the regexp `/core-.*/`) will be associated with a `patch` release.
69+
- Commits with `type` 'docs' and `scope` 'README' will be associated with a `patch` release.
70+
- Commits with `type` 'refactor' and `scope` starting with 'core-' (i.e. 'core-ui', 'core-rules', ...) will be associated with a `minor` release.
71+
- Other commits with `type` 'refactor' (without `scope` or with a `scope` not matching the regexp `/core-.*/`) will be associated with a `patch` release.
7272

7373
#### Default rules matching
7474

7575
If a commit doesn't match any rule in `releaseRules` it will be evaluated against the [default release rules](lib/default-release-rules.js).
7676

7777
With the previous example:
78-
* Commits with a breaking change will be associated with a `minor` release.
79-
* Commits with `type` 'feat' will be associated with a `minor` release.
80-
* Commits with `type` 'fix' will be associated with a `patch` release.
81-
* Commits with `type` 'perf' will be associated with a `patch` release.
78+
- Commits with a breaking change will be associated with a `minor` release.
79+
- Commits with `type` 'feat' will be associated with a `minor` release.
80+
- Commits with `type` 'fix' will be associated with a `patch` release.
81+
- Commits with `type` 'perf' will be associated with a `patch` release.
8282

8383
#### No rules matching
8484

8585
If a commit doesn't match any rules in `releaseRules` or in [default release rules](lib/default-release-rules.js) then no release type will be associated with the commit.
8686

8787
With the previous example:
88-
* Commits with `type` 'style' will not be associated with a release type.
89-
* Commits with `type` 'test' will not be associated with a release type.
90-
* Commits with `type` 'chore' will not be associated with a release type.
88+
- Commits with `type` 'style' will not be associated with a release type.
89+
- Commits with `type` 'test' will not be associated with a release type.
90+
- Commits with `type` 'chore' will not be associated with a release type.
9191

9292
#### Multiple commits
9393

9494
If there is multiple commits that match one or more rules, the one with the highest release type will determine the global release type.
9595

9696
Considering the following commits:
97-
* `docs(README): Add more details to the API docs`
98-
* `feat(API): Add a new method to the public API`
97+
- `docs(README): Add more details to the API docs`
98+
- `feat(API): Add a new method to the public API`
9999

100100
With the previous example the release type determine by the plugin will be `minor`.
101101

@@ -118,13 +118,13 @@ For example with `eslint` preset:
118118
}
119119
```
120120
With this configuration:
121-
* Commits with `tag` 'Docs', that contains 'README' in their header message will be associated with a `patch` release.
122-
* Commits with `tag` 'New' will be associated with a `patch` release.
123-
* Commits with `tag` 'Breaking' will be associated with a `major` release (per [default release rules](lib/default-release-rules.js)).
124-
* Commits with `tag` 'Fix' will be associated with a `patch` release (per [default release rules](lib/default-release-rules.js)).
125-
* Commits with `tag` 'Update' will be associated with a `minor` release (per [default release rules](lib/default-release-rules.js)).
126-
* Commits with `tag` 'New' will be associated with a `minor` release (per [default release rules](lib/default-release-rules.js)).
127-
* All other commits will not be associated with a release type.
121+
- Commits with `tag` 'Docs', that contains 'README' in their header message will be associated with a `patch` release.
122+
- Commits with `tag` 'New' will be associated with a `patch` release.
123+
- Commits with `tag` 'Breaking' will be associated with a `major` release (per [default release rules](lib/default-release-rules.js)).
124+
- Commits with `tag` 'Fix' will be associated with a `patch` release (per [default release rules](lib/default-release-rules.js)).
125+
- Commits with `tag` 'Update' will be associated with a `minor` release (per [default release rules](lib/default-release-rules.js)).
126+
- Commits with `tag` 'New' will be associated with a `minor` release (per [default release rules](lib/default-release-rules.js)).
127+
- All other commits will not be associated with a release type.
128128

129129
#### External package / file
130130

0 commit comments

Comments
 (0)