Skip to content

Commit

Permalink
Small tidy-ups in CONTRIBUTING.md (#2012)
Browse files Browse the repository at this point in the history
* Fix broken link in CONTRIBUTING.md

* Added examples, fixed a couple of typos.
  • Loading branch information
BigLep committed Jun 10, 2024
1 parent 206a772 commit 9210fe9
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Versioning of the primary crates is not strictly semver compatible:

Versioning of the `fvm_ipld_*` crates follows standard semver rules.

All changes should be well tested. See [builtin actors testing][builtin actors testing].
All changes should be well tested. See [builtin actors testing](#builtin-actors-testing).

### Primary FVM crates

Expand All @@ -55,6 +55,8 @@ To propose a new release, open a pull request with the following changes:
section. It may be appropriate to duplicate some entries across these crates if the changes are
relevant to multiple crates.

See [PR #2002](https://github.com/filecoin-project/ref-fvm/pull/2002) for an example.

### Other crates

To propose a release of a crate other than `fvm`, `fvm_shared`, `fvm_sdk`, or
Expand All @@ -77,7 +79,7 @@ Once the release is prepared, it'll go through a review:
Finally, an [FVM "owner"](https://github.com/orgs/filecoin-project/teams/fvm-crate-owners/members) will:

1. Merge the release PR to master.
2. For each released crate, create a git: `crate_name@crate_version`.
2. For each released crate, create a git tag: `crate_name@crate_version`.
3. Run `cargo publish` for each released crate (in dependency order).

### Crate Dependency Graph
Expand All @@ -96,7 +98,7 @@ If you're releasing any non-trivial changes to crates used by the builtin actors

To test:

1. Checkout this repo as `ref-fvm/` and and the builtin-actors repo as `builtin-actors/` in the same directory.
1. Checkout this repo as `ref-fvm/` and the builtin-actors repo as `builtin-actors/` in the same directory.
2. Uncomment the "patch" section in `builtin-actors/Cargo.toml` that starts with:
```toml
[patch.crates-io]
Expand Down

0 comments on commit 9210fe9

Please sign in to comment.