(MODULES-11816) Add CLAUDE.md for Claude Code guidance#1675
Closed
SugatD wants to merge 2 commits into
Closed
Conversation
Document the module's three-layer architecture (globals → params → server), custom types/providers, Hiera data layout, validate/spec/Litmus commands, spec conventions, lint customizations, and how the CI matrix is built.
SugatD
requested review from
a team,
SimonHoenscheid,
alexjfisher,
bastelfreak,
deric,
ekohl and
smortex
as code owners
Branch names now follow <module-id>-<short-change-related-name> (e.g. MODULES-11816-add-claude-md) instead of just the bare ticket id. Test-PR runs of community PRs still use the <module-id>-pr<upstream-pr-number> pattern.
2 tasks
Contributor
Author
|
Superseded by #1676 — the branch was renamed from |
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
1 participant
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.
Summary
Adds a
CLAUDE.mdat the module root to give Claude Code (claude.ai/code) the context it needs to work productively in this repository.The file covers:
postgresql::globals→params.pp→postgresql::serverand whyglobalsmust be included first.params.ppdefault-vs-versioned package-name branch that's easy to break when adding OS support.lib/puppet/(postgresql_psql,postgresql_conf,postgresql_conn_validator,postgresql_replication_slot) and how theserver/*defined types funnel throughpostgresql_psql.data/os/...) and thehiera.yamlhierarchy.rake validate,rake parallel_spec, single-file/example rspec, full Litmus provision/install/run/teardown cycle, andpuppet-stringsreference regeneration.classes/,defines/,functions/,type_aliases/,unit/,acceptance/) and theshared_contextpattern inspec/spec_helper_local.rb..puppet-lint.rcand theRakefile.matrix_from_metadata_v3×puppet_litmus/exe/matrix.json).MODULES-XXXXprefix,Co-authored-by:trailer for community-PR cherry-picks).Test plan