-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
Showing
2 changed files
with
27 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 ./... | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters