cerc-io/ipld-eth-server
18
0
Fork 1
Code Issues 10 Pull Requests 1 Actions Packages Projects Releases 37 Wiki Activity

Address PR comment

Browse Source
This commit is contained in:
Elizabeth Engelman 2019-06-03 13:26:28 -05:00
parent d61f4f3cb4
commit 5088574437
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
documentation/contributing.md
View File

@ -3,7 +3,7 @@
Contributions are welcome! Please open an Issues or Pull Request for any changes. Contributions are welcome! Please open an Issues or Pull Request for any changes.
In addition to core contributions, developers are encouraged to build their own custom transformers which In addition to core contributions, developers are encouraged to build their own custom transformers which
can be run together with other custom transformers using the [composeAndExeucte](../../staging/documentation/composeAndExecute.md) command. can be run together with other custom transformers using the [composeAndExecute](../../staging/documentation/custom-transformers.md) command.
## Pull Requests ## Pull Requests
- `go fmt` is run as part of `make test` and `make integrationtest`, please make sure to check in the format changes. - `go fmt` is run as part of `make test` and `make integrationtest`, please make sure to check in the format changes.
@ -23,12 +23,12 @@ conform to the
converts timestamped migrations to migrations versioned by an incremented integer. converts timestamped migrations to migrations versioned by an incremented integer.
## Diagrams ## Diagrams
- Diagrams were created with [draw.io](draw.io). - Diagrams were created with [draw.io](https://www.draw.io).
- To update a diagram: - To update a diagram:
1. Go to [draw.io](draw.io). 1. Go to [draw.io](https://www.draw.io).
1. Click on *File > Open from* and choose the location of the diagram you want to update. 1. Click on *File > Open from* and choose the location of the diagram you want to update.
1. Once open in draw.io, you may update it. 1. Once open in draw.io, you may update it.
1. Export the diagram to this repository's directory and add commit it. 1. Export the diagram to this repository's directory and commit it.
## Generating the Changelog ## Generating the Changelog

4
documentation/custom-transformers.md
View File

@ -2,9 +2,9 @@
When the capabilities of the generic `contractWatcher` are not sufficient, custom transformers tailored to a specific When the capabilities of the generic `contractWatcher` are not sufficient, custom transformers tailored to a specific
purpose can be leveraged. purpose can be leveraged.
Individual custom transformers can be composed together from any number of external repositories and executed as a Individual custom transformers can be composed together from any number of external repositories and executed as a
single process using the `compose` and `execute` commands or the `composeAndExecute` command. This is accomplished by single process using the `compose` and `execute` commands or the `composeAndExecute` command. This is accomplished by
generating a Go plugin which allows the `vulcanizedb` binary to link to the external transformers, so long as they generating a Go plugin which allows the `vulcanizedb` binary to link to the external transformers, so long as they
abide by one of the standard [interfaces](../staging/libraries/shared/transformer). abide by one of the standard [interfaces](../staging/libraries/shared/transformer).
## Writing custom transformers ## Writing custom transformers