Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 1.44 KB

CONTRIBUTING.md

File metadata and controls

58 lines (40 loc) · 1.44 KB
Raw

Contributing

We'd love to have you as a contributor! This document outlines some general guidelines and instructions to follow when developing and submitting a PR.

Submitting a PR

  • We use trunk based development off of our main branch
  • Try to test your changes as much as possible before submitting a PR - ideally with tests defined in code
  • We use conventional commits to roughly categorize the work done in this repo
  • We try to use the habits described in this article when opening PRs

Development

To run MergeStat locally for development, we use docker-compose with some targets defined in the Makefile.

Running locally

# bring up all containers locally, building from the local source
make dev

Building changes

# build all images
make docker-build

# build the worker image
make docker-build-worker

# build the ui image
make docker-build-ui

# build the graphql service image
make docker-build-graphql

Cleaning Up

# stop running docker containers
make docker-down

# stop running docker containers and remove all networks/volumes (resets the state of the app)
make docker-clean

Running Tests

# run all the Go tests
make test

# run UI tests
cd ui && npm run test