Write a Contributing Guide - Githubissues

cozydev-pink / protosearch

prototype search library in pure scala

https://cozydev-pink.github.io/protosearch/

Apache License 2.0

9 stars 6 forks source link

Write a Contributing Guide #190

Closed valencik closed 6 months ago

valencik commented 6 months ago

We can take inspiration from the http4s contributing guide: https://http4s.org/contributing.html

The basics we need to cover:

how to format code: scalafmtAll and prePR
how to run tests: coreJVM/test
a bit about our big build matrix, and how to focus on just one part
how to do end to end testing in the browser
- publish things locally, publishLocal and then add the sbt plugin to another project, run tlSite, open the search files...