# README

Go-Core

A collection of valuable packages for Golang projects. They are self-sustained and can be imported to any project. To learn more about each package please open the subfolder and see the README.

How to Install

go get github.com/iconimpact/go-core

How to Contribute

Development Setup

Firstly, clone the repo. And then go into the repo root folder, install dependencies and run tests.


go mod download
go test ./... -v -count=1

General Contributor Guidelines

This project is maintained by Sebastian Kreutzberger (@skreutzberger)

Please create a pull request which fulfills the following conditions:

is of general interest and to be used in more than one project
includes a README file which documents the purpose, each public function with an example and how to run and test it
contains inline code comments which make it clear what the logic does (the more comments the better)
has a unit test code coverage of at least 90%
does not violate any patents or copyrights
has the Apache 2.0 copyright statement at the top of each file with icommobile GmbH as copyright holder

License

Go-Core is licensed under the Apache 2.0 License (see file LICENSE).