karalabe / ssz

Opinionated 0-alloc SSZ codec for Go
https://github.com/ethereum/consensus-specs/blob/dev/ssz/simple-serialize.md
BSD 3-Clause "New" or "Revised" License
39 stars 7 forks source link

feat(tools): add basic makefile, to prevent confusion on how to setup tests #21

Open itsdevbear opened 2 months ago

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 83.92%. Comparing base (e314ffd) to head (55e03c6).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #21 +/- ## ======================================= Coverage 83.92% 83.92% ======================================= Files 61 61 Lines 3035 3035 ======================================= Hits 2547 2547 Misses 323 323 Partials 165 165 ``` | [Components](https://app.codecov.io/gh/karalabe/ssz/pull/21/components?src=pr&el=components&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=P%C3%A9ter+Szil%C3%A1gyi) | Coverage Δ | | |---|---|---| | [ssz](https://app.codecov.io/gh/karalabe/ssz/pull/21/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=P%C3%A9ter+Szil%C3%A1gyi) | `83.24% <ø> (ø)` | | | [sszgen](https://app.codecov.io/gh/karalabe/ssz/pull/21/components?src=pr&el=component&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=P%C3%A9ter+Szil%C3%A1gyi) | `70.99% <ø> (ø)` | |
karalabe commented 2 months ago

Wondering whether it would be better to just have a section about it in the readme. For example the tests repo relies on git LFS, which the user would need to install/enable separately. I'd guess that's not possible to outsmart with a Makefile, in which case we're only partially covering the issue.