Skip to content

Commit

Permalink
Reorganize contributing guidelines
Browse files Browse the repository at this point in the history
Moved contributing guidelines from README.md to a new CONTRIBUTING.md file for better maintainability and clarity. Updated instructions include steps for generating and publishing proto files.
  • Loading branch information
billettc committed Aug 14, 2024
1 parent d9bcf49 commit 6022df0
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 9 deletions.
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Contributing

Report any protocol-specific issues in their
[respective repositories](https://github.com/streamingfast/streamingfast#protocols)

**Please first refer to the general
[StreamingFast contribution guide](https://github.com/streamingfast/streamingfast/blob/master/CONTRIBUTING.md)**,
if you wish to contribute to this code base.

This codebase uses unit tests extensively, please write and run tests.

## Generate pb files from proto definition
```bash
cd proto
buf generate
```

## Publish proto definition and add it to `firecore` well known
```bash
cd proto
buf push
```
### Once push go to `firecore` code and edit generator.go to add an entry to wellKnownProtoRepos list.
From root of `firecore` project run ...
```bash
go generate ./...
```
9 changes: 0 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,4 @@ The below command with start streaming Firehose Vara blocks, check `proto/sg/gea
firevara fetch {FIRST_STREAMABLE_BLOCK} --endpoints {VARA_RPC_ENDPOINT} --state-dir {STATE_DIR}
```

## Contributing

Report any protocol-specific issues in their
[respective repositories](https://github.com/streamingfast/streamingfast#protocols)

**Please first refer to the general
[StreamingFast contribution guide](https://github.com/streamingfast/streamingfast/blob/master/CONTRIBUTING.md)**,
if you wish to contribute to this code base.

This codebase uses unit tests extensively, please write and run tests.

0 comments on commit 6022df0

Please sign in to comment.