Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

30 lines (22 loc) · 1.86 KB

Contributing

Firstly, for any feature please make sure you test it, if you can't test the feature then you need to justify why. Templates for tests can be seen at here. For new features, its good to ask before starting work just so we can provide clarity as to whether we would eventually accept the feature request. Opening PR's as soon as possible is also recommended so that we have an early impression of what you are trying to accomplish (also so we can guide and help you).

Try not to add dependencies unless you need to, we try and restrict Kanadi to have the smallest set of dependencies as possible to increase adoption and prevent possible dependency hell friction.

Commit messages should follow the style described here.

The project is formatted with scalafmt. Please format your code before you commit it.

Running Nakadi locally

There is a docker-compose file which you can use in conjunction with docker-compose to run Nakadi locally which is required for running tests. Unfortunately due to limitations of github docker container registry (see issue) you need to login to githubs container registry.

This means that in order to pull the necessary images you need to create a github personal access token with the scope read:packages. After this you need to login to docker for github container registry, i.e.

docker login -u <github username> -p <personal access token> ghcr.io

After this docker-compose should work as expected