Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 1.2 KB

Contributing to edsrv

This document describes the highlevel automation to interact with the project's code-base. The required tools are automatically installed with go install when not yet installed on the environment.

Build

The executables are built by make's default target, as the example below. The executable is placed under ./bin directory configured on Makefile's OUTPUT_DIR variable.

To build the application using your local go installation, run:

make

For snapshot target it uses goreleaser to built the application:

make snapshot

Lint

Static code analysis is done with golangci-lint and rules defined here.

make lint

CI

Continuous integration (CI) tests are declared here, where the following Makefile targets are invoked in order to test different aspects of the project.

In short, to run all tests:

make test

Unit Testing

make test-unit

Integration Testing

make test-integration