Improve how to contribute sections

long2ice / meilisync

Realtime sync data from MySQL/PostgreSQL/MongoDB to Meilisearch

https://github.com/long2ice/meilisync

Apache License 2.0

247 stars 37 forks source link

Open brunoocasali opened 1 year ago

brunoocasali commented 1 year ago

Currently, if someone wants to contribute is quite challenging.

[ ] Add the tests to the CI configuration (today only the linter is required)
[ ] Configure a more straightforward way to try the code without building it in every change. (At least I had to do it every time).
[ ] Provide a docker-compose.yml for development (with MongoDB, MySQL, and PostgreSQL)
[ ] Introduce a CONTRIBUTING.md

long2ice commented 1 year ago

That's good.