You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
📝 Correct sentence structure in documentation (#173)
One of the most glaring examples:
_Previous_
> You didn't the preset you need in the list?
_Updated_
> Didn't see the preset you need in the list?
Additionally various other sentence structure improvements we're made. Hope these help a wider audience grasp the information within this Documentation!
Copy file name to clipboardExpand all lines: DOCUMENTATION.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,7 @@ Here the recommended workflow to generate your changelog file using `gitmoji-cha
71
71
1. Make changes and commit: `git commit -m ":sparkles: my awesome feature"`
72
72
2. Bump version (ex: `1.0.0`) in `package.json` using [semver](https://semver.org/) convention
73
73
3. Run `gitmoji-changelog`, then the file `CHANGELOG.md` is created or updated with all changes
74
-
4. You can freely edit the new release in the changelog file, it will not be overwrite with the next generation
74
+
4. You can freely edit the new release in the changelog file, it will not be overwritten with the next generation
75
75
5. Commit `package.json` and `CHANGELOG.md` file
76
76
6. Tag your release: `git tag -a v1.0.0 -m "v1.0.0"` (or create a Github release)
77
77
7. Push to the remote `git push`
@@ -80,19 +80,19 @@ _This workflow is related to the `node` preset but can be adapted to your own te
80
80
81
81
## Presets
82
82
83
-
`gitmoji-changelog` use presets to get project meta data useful for its smooth operation. Here is the list of available presets:
83
+
`gitmoji-changelog` use presets to get project metadata useful for its smooth operation. Here is the list of available presets:
84
84
85
85
- node (default preset)
86
86
- generic
87
87
- maven
88
88
89
-
You didn't the preset you need in the list? Consider adding it. Presets are stored in a [presets](packages/gitmoji-changelog-cli/src/presets) folder in the `cli` package.
89
+
Didn't see the preset you need in the list? Consider adding it. Presets are stored in a [presets](packages/gitmoji-changelog-cli/src/presets) folder in the `cli` package.
90
90
91
91
### Add a preset
92
92
93
93
A preset need to export a function. When called this function must return three mandatory information about the project in which the cli has been called. The name of the project, a short description of it and its current version.
94
94
95
-
Let's dissect the `node` preset to see how it works. First of all the module must export a function. In case something went wrong return `null`. The cli will tell the user a problem occured.
95
+
Let's dissect the `node` preset to see how it works. First of all the module must export a function. In case something went wrong return `null`. The cli will tell the user a problem occurred.
0 commit comments