From e87a1126d39668762ab058eb3f8e523e8d7668b9 Mon Sep 17 00:00:00 2001 From: Jon Langevin Date: Tue, 19 May 2026 16:32:49 -0400 Subject: [PATCH] docs(modular): add CONTRIBUTING.md to 7 sub-modules 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) --- modules/auth/CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++ modules/cache/CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++ modules/database/CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++ modules/eventbus/CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++ modules/jsonschema/CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++ modules/letsencrypt/CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++ modules/reverseproxy/CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++ 7 files changed, 252 insertions(+) create mode 100644 modules/auth/CONTRIBUTING.md create mode 100644 modules/cache/CONTRIBUTING.md create mode 100644 modules/database/CONTRIBUTING.md create mode 100644 modules/eventbus/CONTRIBUTING.md create mode 100644 modules/jsonschema/CONTRIBUTING.md create mode 100644 modules/letsencrypt/CONTRIBUTING.md create mode 100644 modules/reverseproxy/CONTRIBUTING.md diff --git a/modules/auth/CONTRIBUTING.md b/modules/auth/CONTRIBUTING.md new file mode 100644 index 00000000..5ee3abdb --- /dev/null +++ b/modules/auth/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing to modular/auth + +This is a sub-module of [GoCodeAlone/modular](https://github.com/GoCodeAlone/modular) — a separately-versioned Go module under `modules/auth/`. Its tag stream is `modules/auth/vN.M.P`, independent of the core `modular` package. + +## Before contributing + +Read the top-level [CONTRIBUTING.md](../../CONTRIBUTING.md) for general conventions. + +## Local development + +Sub-module builds standalone: + +```sh +cd modules/auth +go build ./... +go test ./... +``` + +If you have a `go.work` file in a parent directory (multi-repo workspace): + +```sh +GOWORK=off go build ./... +GOWORK=off go test ./... +``` + +## 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. +- 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/auth/vN.M.P`) separately from the core `modular` tag. + +## Reporting issues + +Use the issue templates under `.github/ISSUE_TEMPLATE/` at the repo root. diff --git a/modules/cache/CONTRIBUTING.md b/modules/cache/CONTRIBUTING.md new file mode 100644 index 00000000..938bb992 --- /dev/null +++ b/modules/cache/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing to modular/cache + +This is a sub-module of [GoCodeAlone/modular](https://github.com/GoCodeAlone/modular) — a separately-versioned Go module under `modules/cache/`. Its tag stream is `modules/cache/vN.M.P`, independent of the core `modular` package. + +## Before contributing + +Read the top-level [CONTRIBUTING.md](../../CONTRIBUTING.md) for general conventions. + +## Local development + +Sub-module builds standalone: + +```sh +cd modules/cache +go build ./... +go test ./... +``` + +If you have a `go.work` file in a parent directory (multi-repo workspace): + +```sh +GOWORK=off go build ./... +GOWORK=off go test ./... +``` + +## 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. +- 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/cache/vN.M.P`) separately from the core `modular` tag. + +## Reporting issues + +Use the issue templates under `.github/ISSUE_TEMPLATE/` at the repo root. diff --git a/modules/database/CONTRIBUTING.md b/modules/database/CONTRIBUTING.md new file mode 100644 index 00000000..8f7094d8 --- /dev/null +++ b/modules/database/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing to modular/database + +This is a sub-module of [GoCodeAlone/modular](https://github.com/GoCodeAlone/modular) — a separately-versioned Go module under `modules/database/`. Its tag stream is `modules/database/vN.M.P`, independent of the core `modular` package. + +## Before contributing + +Read the top-level [CONTRIBUTING.md](../../CONTRIBUTING.md) for general conventions. + +## Local development + +Sub-module builds standalone: + +```sh +cd modules/database +go build ./... +go test ./... +``` + +If you have a `go.work` file in a parent directory (multi-repo workspace): + +```sh +GOWORK=off go build ./... +GOWORK=off go test ./... +``` + +## 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. +- 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/database/vN.M.P`) separately from the core `modular` tag. + +## Reporting issues + +Use the issue templates under `.github/ISSUE_TEMPLATE/` at the repo root. diff --git a/modules/eventbus/CONTRIBUTING.md b/modules/eventbus/CONTRIBUTING.md new file mode 100644 index 00000000..4eacf6b1 --- /dev/null +++ b/modules/eventbus/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing to modular/eventbus + +This is a sub-module of [GoCodeAlone/modular](https://github.com/GoCodeAlone/modular) — a separately-versioned Go module under `modules/eventbus/`. Its tag stream is `modules/eventbus/vN.M.P`, independent of the core `modular` package. + +## Before contributing + +Read the top-level [CONTRIBUTING.md](../../CONTRIBUTING.md) for general conventions. + +## Local development + +Sub-module builds standalone: + +```sh +cd modules/eventbus +go build ./... +go test ./... +``` + +If you have a `go.work` file in a parent directory (multi-repo workspace): + +```sh +GOWORK=off go build ./... +GOWORK=off go test ./... +``` + +## 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. +- 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/eventbus/vN.M.P`) separately from the core `modular` tag. + +## Reporting issues + +Use the issue templates under `.github/ISSUE_TEMPLATE/` at the repo root. diff --git a/modules/jsonschema/CONTRIBUTING.md b/modules/jsonschema/CONTRIBUTING.md new file mode 100644 index 00000000..65144989 --- /dev/null +++ b/modules/jsonschema/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing to modular/jsonschema + +This is a sub-module of [GoCodeAlone/modular](https://github.com/GoCodeAlone/modular) — a separately-versioned Go module under `modules/jsonschema/`. Its tag stream is `modules/jsonschema/vN.M.P`, independent of the core `modular` package. + +## Before contributing + +Read the top-level [CONTRIBUTING.md](../../CONTRIBUTING.md) for general conventions. + +## Local development + +Sub-module builds standalone: + +```sh +cd modules/jsonschema +go build ./... +go test ./... +``` + +If you have a `go.work` file in a parent directory (multi-repo workspace): + +```sh +GOWORK=off go build ./... +GOWORK=off go test ./... +``` + +## 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. +- 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/jsonschema/vN.M.P`) separately from the core `modular` tag. + +## Reporting issues + +Use the issue templates under `.github/ISSUE_TEMPLATE/` at the repo root. diff --git a/modules/letsencrypt/CONTRIBUTING.md b/modules/letsencrypt/CONTRIBUTING.md new file mode 100644 index 00000000..7ebbe5a2 --- /dev/null +++ b/modules/letsencrypt/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing to modular/letsencrypt + +This is a sub-module of [GoCodeAlone/modular](https://github.com/GoCodeAlone/modular) — a separately-versioned Go module under `modules/letsencrypt/`. Its tag stream is `modules/letsencrypt/vN.M.P`, independent of the core `modular` package. + +## Before contributing + +Read the top-level [CONTRIBUTING.md](../../CONTRIBUTING.md) for general conventions. + +## Local development + +Sub-module builds standalone: + +```sh +cd modules/letsencrypt +go build ./... +go test ./... +``` + +If you have a `go.work` file in a parent directory (multi-repo workspace): + +```sh +GOWORK=off go build ./... +GOWORK=off go test ./... +``` + +## 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. +- 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/letsencrypt/vN.M.P`) separately from the core `modular` tag. + +## Reporting issues + +Use the issue templates under `.github/ISSUE_TEMPLATE/` at the repo root. diff --git a/modules/reverseproxy/CONTRIBUTING.md b/modules/reverseproxy/CONTRIBUTING.md new file mode 100644 index 00000000..6191cc08 --- /dev/null +++ b/modules/reverseproxy/CONTRIBUTING.md @@ -0,0 +1,36 @@ +# Contributing to modular/reverseproxy + +This is a sub-module of [GoCodeAlone/modular](https://github.com/GoCodeAlone/modular) — a separately-versioned Go module under `modules/reverseproxy/`. Its tag stream is `modules/reverseproxy/vN.M.P`, independent of the core `modular` package. + +## Before contributing + +Read the top-level [CONTRIBUTING.md](../../CONTRIBUTING.md) for general conventions. + +## Local development + +Sub-module builds standalone: + +```sh +cd modules/reverseproxy +go build ./... +go test ./... +``` + +If you have a `go.work` file in a parent directory (multi-repo workspace): + +```sh +GOWORK=off go build ./... +GOWORK=off go test ./... +``` + +## 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. +- 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.