Refactor/ignoring generated go file

ParadigmFoundation / kosu-monorepo

Monorepo for Kosu (濾す). Includes network client, solidity contracts, and supporting libraries/tooling.

https://docs.kosu.io

MIT License

16 stars 4 forks source link

Refactor/ignoring generated go file #386

Closed Freydal closed 4 years ago

Freydal commented 4 years ago

Overview

Description

Testing instructions

Types of changes

[ ] Refactor/enhancement
[ ] Bug fix/behavior correction
[ ] New feature
[ ] Breaking change
[ ] Other, additional

Notes

Status

[ ] Prefix PR title with [WIP] if necessary (changes not yet made).
[ ] Add tests to cover changes as needed.
[ ] Update documentation/changelog as needed.
[ ] Verify all tests run correctly in CI and pass.
[ ] Ready for review/merge.

Freydal commented 4 years ago

@gchaincl (@hrharder too) Does this seem fine to remove this file from source control and just generate it?

Freydal commented 4 years ago

So in my opinion something needs to change, but it could alternatively be handled by removing automated execution of the generation.

I feel like generated code should either be:

Selectively and intentionally generated and tracked within source control.
Routinely generated and source assets tracked within source control.

I think an alternative would be removing the generation from the go-kosu/package.json build script.

qustavo commented 4 years ago

I think an alternative would be removing the generation from the go-kosu/package.json build script. @Freydal would it make sense to move this generation to //go:generate?

Freydal commented 4 years ago

I believe it is go:generate that is being called. Though the build script initiating the call is being called in the global mono repo build (which is possibly the right thing to do).

hrharder commented 4 years ago

@Freydal @gchaincl I don't have a strong opinion either way here, so am happy to let you two decide if you're able to come to an agreement. :)

If not, let me know and I can help decide.