template-go

If you are beginning your journey with Senzing, please start with Senzing Quick Start guides.

You are in the Senzing Garage where projects are "tinkered" on. Although this GitHub repository may help you understand an approach to using Senzing, it's not considered to be "production ready" and is not considered to be part of the Senzing product. Heck, it may not even be appropriate for your application of Senzing!

⚠️ WARNING: template-go is still in development ⚠️ _

At the moment, this is "work-in-progress" with Semantic Versions of 0.n.x. Although it can be reviewed and commented on, the recommendation is not to use it yet.

Synopsis

The template-go repository serves as a starting point for new repositories hosting Go code. It also shows best practices that can be retro-fitted into existing repositories hosting Go code.

Overview

Aspects of the template-go repository:

1. Badges: Example badges can be seen above.
2. Makefile: Simplifies development lifecycle commands.
3. Sample code: main.go and examplepackage code examples.
4. Sample test cases: *_test.go files showing how to write and document test cases.
5. Sample documentation: Documentation style conducive to the Go Package library.
6. Dockerfile: Containerizing the Go program.
7. RPM/DEB builds: Using package.Dockerfile to build RPM and DEB files for installation.
8. .github/workflows: GitActions tailored to Go programming.
9. .github/dependabot.yml Specifications for keeping Go dependencies up-to-date.

Use

See main.go for an example of use.

References

1. API documentation
2. Development
3. Errors
4. Examples
5. Package reference
6. Related artifacts:
   1. DockerHub