docs(modular): add CHANGELOG + CONTRIBUTING (QoL sweep follow-up)#110
Merged
Conversation
modular is the foundation library for the workflow + ratchet + cloud ecosystem. README was already substantial but CHANGELOG + CONTRIBUTING were missing. Adds both, documenting the multi-module tag stream (core `vN.M.P` + per-sub-module `modules/<name>/vN.M.P`) and the GOWORK=off pattern for multi-repo workspaces. Closes modular#109. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds CHANGELOG.md and CONTRIBUTING.md to the modular repository as a QoL/OSS-readiness follow-up to issue #109, documenting the multi-module tag stream and the GOWORK=off build pattern for contributors working in a multi-repo workspace.
Changes:
- New
CONTRIBUTING.mdcovering local development,GOWORK=offusage, sub-module builds, and PR expectations. - New
CHANGELOG.mdin Keep-a-Changelog format, noting the multi-module tag scheme.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| CONTRIBUTING.md | Contributor guide with build/test commands and PR conventions. |
| CHANGELOG.md | Initial changelog scaffolding with multi-module versioning notes. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
intel352
added a commit
that referenced
this pull request
May 19, 2026
Follow-up to #110 (top-level CONTRIBUTING). Each sub-module under modules/ is a separately-versioned Go module; document the sub-module tag stream + GOWORK=off pattern per directory. Sub-modules covered: auth, cache, database, eventbus, jsonschema, letsencrypt, reverseproxy. Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
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.
Closes #109. modular is the workflow ecosystem foundation lib; missing CHANGELOG + CONTRIBUTING was a gap for external contributors. Adds both, documenting the multi-module tag stream + GOWORK=off pattern.