golang-utils icon indicating copy to clipboard operation
golang-utils copied to clipboard

Helpers and utilities for Golang in order to do actions not available in the standard library.

Golang utilities

Go Badge License CI Go Reference Documentation Go Report Card Maintainability Test Coverage CII Best Practices

Overview

This repository contains various helpers and utilities for Golang in order to do actions not available in the standard library. It was initially developed for numerous projects at Arm, including some running in production, in order to apply the DRY principle.

Few helpers may be themselves leveraging 3rd party libraries.

Maintainers: @ARM-software/golang-utils-admin

Using this library

To use this library, add the following line to your go.mod:

require (
    github.com/ARM-software/golang-utils/utils latest
    ...
)

Releases

For release notes and a history of changes of all production releases, please see the following:

  • Changelog

Project Structure

The follow described the major aspects of the project structure:

  • docs/ - Code reference documentation.
  • utils/ - Go project source files.
  • changes/ - Collection of news files for unreleased changes.

Getting Help

  • For interface definition and usage documentation, please see GitHub Pages.
  • For a list of known issues and possible workarounds, please see Known Issues.
  • To raise a defect or enhancement please use GitHub Issues or GitHub discussions.

Contributing

  • We are committed to fostering a welcoming community, please see our Code of Conduct for more information.
  • For ways to contribute to the project, please see the Contributions Guidelines
  • For a technical introduction into developing this package, please see the Development Guide