Skip to content

Commit 36872a0

Browse files
DanielTamkinfrinyvonnick
authored andcommitted
📝 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!
1 parent c214fb7 commit 36872a0

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

DOCUMENTATION.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Here the recommended workflow to generate your changelog file using `gitmoji-cha
7171
1. Make changes and commit: `git commit -m ":sparkles: my awesome feature"`
7272
2. Bump version (ex: `1.0.0`) in `package.json` using [semver](https://semver.org/) convention
7373
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
7575
5. Commit `package.json` and `CHANGELOG.md` file
7676
6. Tag your release: `git tag -a v1.0.0 -m "v1.0.0"` (or create a Github release)
7777
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
8080

8181
## Presets
8282

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:
8484

8585
- node (default preset)
8686
- generic
8787
- maven
8888

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.
9090

9191
### Add a preset
9292

9393
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.
9494

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.
9696

9797
```js
9898
module.exports = () => {
@@ -169,7 +169,7 @@ docker container run -it -v $(pwd):/app --rm yvonnick/gitmoji-changelog:dev
169169
## 🐥 Canary version
170170

171171
If you want to test the incoming release of gitmoji-changelog, you can use or install the canary version.
172-
Be aware, it's a development in progress version, feel free to report bug or give feedback.
172+
Be aware, it's a development in progress version, feel free to report any bugs plus give feedback.
173173

174174
with npx:
175175
```sh

0 commit comments

Comments
 (0)