Skip to content

Commit

Permalink
docs: add sample changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
adhocore committed Aug 14, 2018
1 parent 6450952 commit 757694b
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,29 @@ And [here](https://i.imgur.com/mQaiAuk.png) is colorful screenshot of `please` r
And here is a preview of all [features](https://www.npmjs.com/package/@adhocore/devnull) of `please` in one [release](https://github.com/adhocore/dev-null/releases/tag/0.0.6):
![Full Preview](https://imgur.com/TXI6Jst.png "Full Feature Preview")

### Sample changelog

[CHANGELOG.md](./CHANGELOG.md) generated by `please` looks like:

```
## [0.0.1] 2018-01-01 00:00:00 UTC
- commit 1
- commit 2
...
```

If you passed in `--chash` flag then:

```
## [0.0.1] 2018-01-01 00:00:00 UTC
- [<commit1hash>](https://github.com/<repo>/commit/<commit1hash>) commit 1
- [<commit2hash>](https://github.com/<repo>/commit/<commit2hash>) commit 2
...
```

On subsequent releases new changes are prepended such that latest commits stay at top.

### Troubleshooting

Expand Down

0 comments on commit 757694b

Please sign in to comment.