stl

README

Opinionated standard library for Go programming language

This package contains the library extension and simplification I always missed and could not fill the gap in my every day development. This repository has been created right after Go 1.18 release with the generics support. It was the main problem to build the simple library with good performance. This package wont try to replace the standard library, but it will try to extend and simplify it.

Goals

There are the main goals of this library:

• Implement and tests the most common functions and structures of the standard library
• The simplicity and generalization should not affect performance
• This library should be easy to use and understand
• This library MUST simplify developer's experience, but not make it more complicated

Documentation

To make documentation more standartized and always up-to-date, we use GoDoc (pkg.go.dev/github.com/aohorodnyk/stl). It is the best documentation tool for Go.

Every feature or feature change should introduce some changes in comments, doc.go, README.md and tests include examples.

Different types usage in the library

As we can mention, all the generic types are specified on te structure level, instead of the Get functions' levels. The implementation has been done, because of the Golang generics limitations where we cannot use generic's types on method level (more informaton here and here).

So, if you need to have different types on the value level, you can use any type and cast result by using types.Cast and types.CastOk functions.

It's clear that the Golang's genetics implementation is not flexible enough for this kind of generic solutions, however, in the many cases it will work well without any problems. And we hope that aditional Cast function will not break the developer experience too much.

Contributing

The library is open source and you can contribute to it.

Before contrbution, make sure that githook is configured for you and all your commits contain the correct issue tag.

Branch Name

Before you start the contribution, make sure that you are on the correct branch. Branch name should start from the issue number dash and short explanation with spaces replaced by underscores. Example:

• 1-my_feature
• 2-fix_bug
• 234-my_important_pr

Git Hook

To configure the git hook, you need to simply run the command: git config core.hooksPath .githooks

It will configure the git hook to run the pre-commit script. Source code of the hook is in .githooks/prepare-commit-msg.

This git-hook will parse branch name and add the issue tag to the commit message.