Skip to content

Commit

Permalink
fix release instructions,
Browse files Browse the repository at this point in the history
mention `serde` feature in README;
  • Loading branch information
greenhat committed Oct 14, 2021
1 parent 2c7cbab commit 44dbde1
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,9 @@ When we're ready to release, a project owner should do the following:

- Create(checkout) a release branch (naming convention `release/vX-Y-Z`);
- install or update "cargo release" (via `cargo install cargo-release`);
- `cargo release minor --no-dev-version -vv --dry-run` if you intend to bump a minor version
- `cargo release minor --no-dev-version -vv` if you intend to bump a minor version
or change `minor` to `major` to bump a major version, `patch` to bump a patch/hotfix version
- check the output and run it without `--dry-run` to actually execute it(make sure that you have api token from `crates.io`, otherwise run `cargo login` first);
- check the output and run it with `--execute` to actually execute it(make sure that you have api token from `crates.io`, otherwise run `cargo login` first);
- Merge release branch into develop
- Merge release branch into master
- Make a github release
Expand Down
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ let data = data.mapped(|x|x*2);
assert_eq!(data, [2u8,4].into());
```

## Crate features
- optional(non-default) `serde` feature that adds serialization to `BoundedVec`.

## Changelog
See [CHANGELOG.md](CHANGELOG.md).

Expand Down

0 comments on commit 44dbde1

Please sign in to comment.