search

baler-collaboration / baler

Repository of Baler, a machine learning based data compression tool
https://github.com/baler-collaboration/baler.github.io
Apache License 2.0
30 stars 26 forks source link

Documentation for developers #335

Closed urania277 closed 8 months ago

urania277 commented 9 months ago

When a new developer joins, they can't easily find in the documentation how to test their changes. We could have a README for developers, I volunteer if someone instructs me as it's been a while since I made changes :)

fritjof-b commented 9 months ago

I wrote some scripts located in bin/ that should be run from the root like so 

./bin/tests.sh
./bin/syntax.sh

All of the scripts that run in the CI-pipeline are located in the bin/ folder. If these scripts succeed locally, so should the CI pipeline. See this for steps in CI.

All dependencies should be installed prior to doing this. Also, we should prompt developers to add tests for the code that they write. I'm not sure if we do this.