docs(modular): add CONTRIBUTING.md to 7 sub-modules#111
Merged
Conversation
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>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds per-submodule contribution guides for the separately versioned modules, following up on the root-level contribution documentation and documenting standalone module development commands.
Changes:
- Added
CONTRIBUTING.mdto 7 module directories. - Documented module-specific tag streams and
GOWORK=offbuild/test workflow. - Added PR and issue-reporting guidance for each submodule.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
modules/auth/CONTRIBUTING.md |
Adds contribution guidance for the auth module. |
modules/cache/CONTRIBUTING.md |
Adds contribution guidance for the cache module. |
modules/database/CONTRIBUTING.md |
Adds contribution guidance for the database module. |
modules/eventbus/CONTRIBUTING.md |
Adds contribution guidance for the eventbus module. |
modules/jsonschema/CONTRIBUTING.md |
Adds contribution guidance for the jsonschema module. |
modules/letsencrypt/CONTRIBUTING.md |
Adds contribution guidance for the letsencrypt module. |
modules/reverseproxy/CONTRIBUTING.md |
Adds contribution guidance for the reverseproxy module. |
Comments suppressed due to low confidence (7)
modules/auth/CONTRIBUTING.md:36
- This path points contributors to
.github/ISSUE_TEMPLATE/, but that directory is not present in the repository. Please either add the issue templates or update this sentence to point to the actual issue reporting location.
Use the issue templates under `.github/ISSUE_TEMPLATE/` at the repo root.
modules/cache/CONTRIBUTING.md:36
- This path points contributors to
.github/ISSUE_TEMPLATE/, but that directory is not present in the repository. Please either add the issue templates or update this sentence to point to the actual issue reporting location.
Use the issue templates under `.github/ISSUE_TEMPLATE/` at the repo root.
modules/database/CONTRIBUTING.md:36
- This path points contributors to
.github/ISSUE_TEMPLATE/, but that directory is not present in the repository. Please either add the issue templates or update this sentence to point to the actual issue reporting location.
Use the issue templates under `.github/ISSUE_TEMPLATE/` at the repo root.
modules/eventbus/CONTRIBUTING.md:36
- This path points contributors to
.github/ISSUE_TEMPLATE/, but that directory is not present in the repository. Please either add the issue templates or update this sentence to point to the actual issue reporting location.
Use the issue templates under `.github/ISSUE_TEMPLATE/` at the repo root.
modules/jsonschema/CONTRIBUTING.md:36
- This path points contributors to
.github/ISSUE_TEMPLATE/, but that directory is not present in the repository. Please either add the issue templates or update this sentence to point to the actual issue reporting location.
Use the issue templates under `.github/ISSUE_TEMPLATE/` at the repo root.
modules/letsencrypt/CONTRIBUTING.md:36
- This path points contributors to
.github/ISSUE_TEMPLATE/, but that directory is not present in the repository. Please either add the issue templates or update this sentence to point to the actual issue reporting location.
Use the issue templates under `.github/ISSUE_TEMPLATE/` at the repo root.
modules/reverseproxy/CONTRIBUTING.md:36
- This path points contributors to
.github/ISSUE_TEMPLATE/, but that directory is not present in the repository. Please either add the issue templates or update this sentence to point to the actual issue reporting location.
Use the issue templates under `.github/ISSUE_TEMPLATE/` at the repo root.
| ## Pull requests | ||
|
|
||
| - One feature or bugfix per PR. Keep changes scoped to this sub-module. | ||
| - Update CHANGELOG.md (in this sub-module's directory) with a Keep-a-Changelog entry. |
| ## Pull requests | ||
|
|
||
| - One feature or bugfix per PR. Keep changes scoped to this sub-module. | ||
| - Update CHANGELOG.md (in this sub-module's directory) with a Keep-a-Changelog entry. |
| ## Pull requests | ||
|
|
||
| - One feature or bugfix per PR. Keep changes scoped to this sub-module. | ||
| - Update CHANGELOG.md (in this sub-module's directory) with a Keep-a-Changelog entry. |
| ## Pull requests | ||
|
|
||
| - One feature or bugfix per PR. Keep changes scoped to this sub-module. | ||
| - Update CHANGELOG.md (in this sub-module's directory) with a Keep-a-Changelog entry. |
| ## Pull requests | ||
|
|
||
| - One feature or bugfix per PR. Keep changes scoped to this sub-module. | ||
| - Update CHANGELOG.md (in this sub-module's directory) with a Keep-a-Changelog entry. |
| ## Pull requests | ||
|
|
||
| - One feature or bugfix per PR. Keep changes scoped to this sub-module. | ||
| - Update CHANGELOG.md (in this sub-module's directory) with a Keep-a-Changelog entry. |
Comment on lines
+29
to
+36
| - Update CHANGELOG.md (in this sub-module's directory) with a Keep-a-Changelog entry. | ||
| - Add tests covering new behaviour — match this sub-module's existing test style. | ||
| - Run `GOWORK=off go vet ./...` before pushing. | ||
| - Bump the sub-module tag (`modules/reverseproxy/vN.M.P`) separately from the core `modular` tag. | ||
|
|
||
| ## Reporting issues | ||
|
|
||
| Use the issue templates under `.github/ISSUE_TEMPLATE/` at the repo root. |
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.
Follow-up to #110. Each modules// sub-dir is separately versioned and gets its own CONTRIBUTING documenting tag stream + GOWORK=off pattern.