Files

T

eSliderandCursor 36f0ed9b52 docs: add CONTRIBUTING guide and expand README

Add CONTRIBUTING.md for testing, PR checks, and release-please flow; link from
README and AGENTS. Document envc bash sourcing (set -a, source <(...)) for YAML/INI.

Co-authored-by: Cursor <cursoragent@cursor.com>

2026-05-03 10:29:27 +01:00

1.2 KiB

Raw Blame History

AGENTS.md — `go-config`

This module is part of the eSlider go-* library standard (inventar ASR-0008).

Purpose

Convert env, YAML, JSON, and INI into nested map[string]any and Go structs (and back), with multi-source merging and the envc CLI.

Public API surface

Subpackages: env, yaml, json, ini — each exports New, (*Codec).Map, Unmarshal, UnmarshalContext, Marshal, WriteTo, and format-specific options.
cmd/envc — binary envc: convert, get, merge.
Internals under internal/ are not stable API.

Breaking changes require a new major SemVer tag (or /v2 module path if the policy changes).

Testing policy, PR checklist, and releases

Human-oriented detail lives in CONTRIBUTING.md (testing rules, go test / lint commands, Conventional Commits, and the release-please / GoReleaser flow). Follow that document for any change that will ship in a versioned release.

Decisions

Architecture Significant Requirements: docs/asr/README.md.

inventar/docs/asr/ASR-0008.md — Go library module conventions
go-onlyoffice/AGENTS.md — reference for the eSlider library template

1.2 KiB Raw Blame History

AGENTS.md — go-config