Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 1.41 KB

README.md

File metadata and controls

38 lines (25 loc) · 1.41 KB
Raw

CodeCombat Go Library

The CodeCombat Go library provides convenient access to the CodeCombat API from Go.

go shield fern shield

Installation

Run the following command to use the CodeCombat Go library in your Go module:

go get github.com/codecombat/codecombat-go

This module requires Go version >= 1.19.

Usage

#TODO

Beta status

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your go.mod file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!