heremaps / flatdata

Write-once, read-many, minimal overhead binary structured file format.
Apache License 2.0
180 stars 28 forks source link

Create a `How to contribute` section #192

Open InfinityByTen opened 4 years ago

InfinityByTen commented 4 years ago

Based on the discussion below, create a new contribution guide section, including what tests to run and how to verify things locally.

I seem to often run into this issue of tests failing on CI. This time it happened because I just had forgotten where to run the tests from. Should we have a separate task to put into a README how to run tests locally?

That makes sense: Some How to contribute section with advice how to test the individual components:

Do you want to create a new issue for that? And would you like to fill that yourself, or have it filled by regular contributors?

Originally posted by @VeaaC in https://github.com/heremaps/flatdata/pull/189#issuecomment-656626074

gferon commented 4 years ago

I would even go further and add a Makefile to do all of this in one command. It can even be properly documented with very exhaustive comments.