Merge pull request #483 from filecoin-project/doc/contributing

doc: add changelogs and contributing docs

Author: Stebalien

CONTRIBUTING.md

@@ -0,0 +1,52 @@
+# Contributing
+
+This document describes the process of contributing to the reference FVM implementation (this project).
+
+## Issues
+
+If you have a general FVM related question or idea, please either as on the [Filecoin Slack][chat], or open
+a new discussion in [fvm-specs][discuss].
+
+If you'd like to report a _bug_ or suggest an enhancement in the reference FVM implementation, please file [an issue][issue].
+
+## Pull Requests
+
+To make a change to the FVM.
+
+1. When in doubt, open an [issue][] first to discuss the change.
+2. Make your change.
+3. Write a test for your change.
+4. Update the crate's `CHANGELOG.md`. If you're making any breaking changes, prefix change with
+   "BREAKING:".
+5. Finally, open a PR.
+
+## Releasing
+
+To prepare a release.
+
+1. Pick a next version (for each crate you're releasing). Look through the changelogs and carefully
+   decide if it's a breaking release or not. Then read [rust's semver
+   documentation](https://doc.rust-lang.org/cargo/reference/semver.html).
+2. Install `cargo-edit` (`cargo install cargo-edit`).
+3. Create a new branch.
+4. Use `cargo set-version` to set the version for each crate you're releasing. This will both update
+   the crate version, and make all other crates in the workspace depend on the latest version.
+5. Make sure the changelogs are all up-to-date, set the release date & version, and add a new
+   "Unreleased" section.
+6. Comment your changes, and make a PR.
+
+Once the release is prepared, it'll go through a review:
+
+1. Make sure that we're _ready_ to release. E.g., make sure downstream can consume the release.
+2. Make sure that we're correctly following semver.
+3. Make sure that we're not missing anything in the changelogs.
+
+Finally, an FVM "owner" will:
+
+1. Merge the release PR to master.
+2. For each released crate, create a git: `crate_name@crate_version`.
+3. Run `cargo publish` for each released crate (in dependency order).
+
+[chat]: https://docs.filecoin.io/about-filecoin/chat-and-discussion-forums/#chat
+[discuss]: https://github.com/filecoin-project/fvm-specs/discussions
+[issue]: https://github.com/filecoin-project/ref-fvm/issues

fvm/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+Changes to the reference FVM implementation.
+
+## [Unreleased]
+
+- Updates to fvm_shared 0.5.

ipld/amt/CHANGELOG.md

@@ -1,13 +1,3 @@
-# 1.0.0 [2021-04-19]
+# Changelog
 
-- Dynamic bit width functionality
-    - Updates serialized format, this is a breaking change
-- Removes inefficient caching, under the `go-interop` feature flag.
-- Fixes expand and collapse bug written into actors v0 and v2
-- v3 Actors compatible Amt
-- Changed index to usize for more idiomatic usages
-- Updated `MAX_INDEX` to take full advantage of the range of values.
-
-# 0.2.0 [2021-02-02]
-
-- Switched `new_from_slice` function to `new_from_iter` which takes a generic type which can be converted into an iterator of the Amt type, avoiding clones.
+## [Unreleased]

ipld/bitfield/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+Changes to Filecoin's Bitfield library.
+
+## [Unreleased]

ipld/blockstore/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+Changes to the FVM's Blockstore abstraction
+
+## [Unreleased]

ipld/car/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+Changes to the FVM's CAR implementation.
+
+## [Unreleased]

ipld/encoding/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+Changes to the FVM's shared encoding utilities.
+
+## [Unreleased]

ipld/hamt/CHANGELOG.md

@@ -1,16 +1,3 @@
-# 2.0.0 [2021-04-19]
+# Changelog
 
-- `set_if_absent` function added. This inserts a value only if the key does not already exist in the Hamt.
-- `set` now doesn't require flushes when the value set is equal to the one that already exists. This is needed for go interop and removes the need for an extra flush or checking if exists in a separate operation.
-- `set` now returns the value that existed for that Key, or `None` if there was no value at that index previously.
-- Updates the serialization format of the `Pointer` type to be a kinded union rather than keyed Cbor bytes. This is also needed for `v3` hamt go interop
-- Actors v3 compatible version
-
-# 1.0.0 [2021-02-03]
-
-- `v2` feature removed
-- Actors v2 compatible version.
-
-# 0.1.1 [2020-12-11]
-
-- v0 Actors compatible Hamt. This release is the same as v2, except that the bug fix for delete reordering is under feature `v2`
+## [Unreleased]

sdk/CHANGELOG.md

@@ -1,5 +1,7 @@
 # Changelog
 
-## 0.5.0 - 2022-04-11
+## [Unreleased]
+
+## 0.5.0 [2022-04-11]
 
 Upgrades the SDK to fvm_shared 0.5.0. This release includes a significant breaking change to exit codes.

shared/CHANGELOG.md

@@ -1,10 +1,12 @@
 # Changelog
 
-## 0.5.1 - 2022-04-11
+## [Unreleased]
+
+## 0.5.1  [2022-04-11]
 
 Add the `USR_ASSERTION_FAILED` exit code.
 
-## 0.5.0 - 2022-04-11
+## 0.5.0 [2022-04-11]
 
 - Enforce maximum big-int size to match lotus.
 - Make signature properties public.