Skip to content

Commit

Permalink
update contracts README with changesets (#13002)
Browse files Browse the repository at this point in the history
* update contracts README with changesets

* add date for 1.1.0 release

* update with more explicit direction
  • Loading branch information
momentmaker authored Apr 26, 2024
1 parent b1c8d74 commit 0370aa9
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
4 changes: 2 additions & 2 deletions contracts/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# @chainlink/contracts CHANGELOG.md
# @chainlink/contracts

## 1.1.0
## 1.1.0 - 2024-04-23

### Minor Changes

Expand Down
16 changes: 16 additions & 0 deletions contracts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,22 @@ contribution information.

Thank you!

### Changesets

We use [changesets](https://github.com/changesets/changesets) to manage versioning the contracts.

Every PR that modifies any configuration or code, should most likely accompanied by a changeset file.

To install `changesets`:
1. Install `pnpm` if it is not already installed - [docs](https://pnpm.io/installation).
2. Run `pnpm install`.

Either after or before you create a commit, run the `pnpm changeset` command in the `contracts` directory to create an accompanying changeset entry which will reflect on the CHANGELOG for the next release.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## License

[MIT](https://choosealicense.com/licenses/mit/)

0 comments on commit 0370aa9

Please sign in to comment.