Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BUG: Updated changelog instructions #1644

Merged
merged 4 commits into from
Dec 7, 2021
Merged

BUG: Updated changelog instructions #1644

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
647f120
updated changelog instructions
fkneeland-figure Dec 3, 2021
d66e03f
Apply suggestions from code review
romac Dec 6, 2021
c00c161
Merge branch 'master' into fred/update-unclog-instructions
adizere Dec 7, 2021
b33ef3d
Nits in the contrib document
adizere Dec 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Apply suggestions from code review
  • Loading branch information
@romac
romac authored Dec 6, 2021
commit d66e03fb6f42043ffe8eae891d9cbbe1924086f0
2 changes: 1 addition & 1 deletion .changelog/unreleased/bug/1634-update-unclog-instructions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
- update CONTRIBUTING.md for latest version of unclog
- Update `CONTRIBUTING.md` for latest version of unclog
([#1634](https://github.com/informalsystems/ibc-rs/issues/1634))
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ To pull in updates from the origin repo, run

Every non-trivial PR must update the [CHANGELOG](CHANGELOG.md). This is
accomplished indirectly by adding entries to the `.changelog` folder in
[unclog](https://github.com/informalsystems/unclog) format using the unclog cli tool.
[`unclog`](https://github.com/informalsystems/unclog) format using the `unclog` CLI tool.
`CHANGELOG.md` will be built by whomever is responsible for performing a release just
prior to release - this is to avoid changelog conflicts prior to releases.

Expand All @@ -98,23 +98,23 @@ prior to release - this is to avoid changelog conflicts prior to releases.
cargo install unclog
```

unclog add --editor vim --id allow-fee-granters --section features --issue-no 1633 --message "Added support for fee granters through config file"
unclog add -i update-unclog-instructions -s bug -n 1634 -m "update CONTRIBUTING.md for latest version of unclog" --editor vim
$ unclog add --editor vim --id allow-fee-granters --section features --issue-no 1633 --message "Added support for fee granters through config file"
$ unclog add -i update-unclog-instructions -s bug -n 1634 -m "Update CONTRIBUTING.md for latest version of unclog" --editor vim

### Examples

Add a .changelog entry for the `ibc` crate (in the `modules` directory)
under the `IMPROVEMENTS` section in CHANGELOG.md.
under the `IMPROVEMENTS` section in `CHANGELOG.md`.

```bash
unclog add -c ibc -s improvements -i some-issue -n 1234 -n "msg about change" --editor vim
$ unclog add -c ibc -s improvements -i some-issue -n 1234 -n "msg about change" --editor vim
```

Add a .changelog entry for the `ibc-relayer-cli` crate (in the `relayer-cli`
directory) under the `FEATURES` section in CHANGELOG.md.

```bash
unclog add -c ibc-relayer-cli -s features -i some-other-issue -n 1235 -n "msg about change" --editor vim
$ unclog add -c ibc-relayer-cli -s features -i some-other-issue -n 1235 -n "msg about change" --editor vim
```

### Preview unreleased changes
Expand Down