all: prepare repository for open-source publication#32
Merged
Conversation
Replace the CI/Go Report Card/License badges with the badge row used across tarantool Go repos (go-storage): Go Reference, Coveralls coverage, and Telegram EN/RU, as reference-style links above the title.
Adopt the checks go-storage runs that were missing here: - Coverage job: go test -covermode=atomic on ubuntu, uploaded to Coveralls via goveralls with GITHUB_TOKEN — feeds the README badge. - Codespell step in the static job (Linux leg), with .codespellrc skipping testdata and whitelisting unparseable/crashers/pathC. - Govulncheck workflow: weekly cron, PRs, and manual dispatch, scanning both the root and examples modules; unlike go-storage's version, the notification step is guarded with always() so it can actually fire after a failed scan.
Enable depguard (previously disabled for lack of a policy) with an explicit allow-list of stdlib plus the vetted public dependencies the non-test code actually imports: google/uuid, klauspost/compress/zstd, and tarantool/go-iproto, plus this module's own path. Any accidental internal or unlisted import now fails at lint time, before it can reach a published release, rather than surfacing after publication. Part of #17
Relocate each public package's existing package-level doc comment into a dedicated doc.go file, following the Go ecosystem convention (as in go-storage). The comments are moved verbatim; no wording changes. This keeps the package overview in the conventional, discoverable place and leaves the former host files carrying only their code. Part of #17
These four packages had no testable examples, so pkg.go.dev rendered no usage for their public APIs. Add ExampleXxx functions with verified Output blocks: filter predicates, format codec (VClock, Meta, XRow round-trip, CRC32C), directory indexing and LSN/vclock lookup, and size-based rotation with vclock-linked chains. All deterministic and compiled/executed under go test. Part of #17
Add bug-report and feature-request issue templates and mirror the go-storage pull request template (self-review checklist covering commit messages, tests, changelog, and docs). Gives external contributors the expected structure for filing issues and PRs. Part of #17
Internal branches triggered CI twice: once for the push and once for the pull request. Add a job-level condition so jobs run on push and on pull requests from forks, but skip pull requests opened from a branch of this same repository. fuzz.yml is left unchanged as it has no pull_request trigger. Part of #17
Add a contribution guide covering first steps, branch naming, running the unit/race/integration tests and coverage, examples, linting, formatting, spell checking, the code-review checklist, the commit-message convention, and the pull-request process. Link it from the README. Part of #17
bigbes
changed the title
sssciel
approved these changes
Jul 16, 2026
patapenka-alexey
approved these changes
Jul 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Prepare go-xlog for open-source publication — work through the code-side readiness checklist: repository metadata, lint and CI hardening, package documentation, examples, and contributor-facing files.
Part of #17