api: Document API change process

This commit is contained in:
Łukasz Magiera
2021-04-26 20:36:20 +02:00
parent 86d4f5f738
commit bfa332ca7d
7 changed files with 95 additions and 0 deletions
+11
View File
@@ -26,6 +26,17 @@ import (
"github.com/filecoin-project/lotus/extern/sector-storage/storiface"
)
// MODIFYING THE API INTERFACE
//
// When adding / changing methods in this file:
// * Do the change here
// * Adjust implementation in `node/impl/`
// * Run `make gen` - this will:
// * Generate proxy structs
// * Generate mocks
// * Generate markdown docs
// * Generate openrpc blobs
// StorageMiner is a low-level interface to the Filecoin network storage miner node
type StorageMiner interface {
Common