Skip to content

Latest commit

 

History

History
57 lines (38 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

57 lines (38 loc) · 1.83 KB
Raw

Contributing to Gidari

Thank you for your interest in contributing to Gidari! Please make sure to fork this repository before working through issues.

Bug Fixes and New Features

See the Gidari MVP project list for open issues, please only focus on issues in the "Scheduled" column. Issues labeled with "good first issue" are excellent starting points for new engineers. If you have completed an issue:

  1. Fork this repository
  2. Create a pull request pointing to "main"
  3. Add a reviewer

All pull requests are subject to the GitHub workflow CI defined in the Actions section of the repository.

Dependencies

To develop locally you need to install the following dependencies:

  1. Docker: https://docs.docker.com/get-docker/
  2. Go: https://go.dev/doc/install
  3. protobuf: http://google.github.io/proto-lens/installing-protoc.html
  4. protoc-gen-go: https://developers.google.com/protocol-buffers/docs/gotutorial#compiling-your-protocol-buffers

Build

To build a binary (this is not a required step):

make

Integration Testing

Gidari is a web-to-storage data transport, which means that integration tests are inevitable. This is an imperfect practice and any constructive feedback on improving the workflow is much appreciated.

Network Updates

You will also need to sync your /etc/hosts file with the docker containers:

# Alpine Hodler Containers
127.0.0.1 mongo1
127.0.0.1 mongo2
127.0.0.1 mongo3
127.0.0.1 postgres1

Running Integration Tests

To test locally first build the containers for integration tests using make containers. Then run make tests.