/ 
Dist-Conformance-0.001
/ Dist::Conformance::Check::ClaudeMd

NAME

Dist::Conformance::Check::ClaudeMd - CLAUDE.md exists and names the skills that it must

VERSION

version 0.001

DESCRIPTION

The instructions that an agent reads first. The check passes when the file exists and contains each string of mentions. It fails when the file is missing, or when a string is not in it.

Its update writes nothing. What the file says about a repository is prose that a person writes, so the update names the file, the template to start from, and what the file lacks.

METHODS

check

update

Records what the file needs, for a person.

IN A FLAVOR

checks:
  ClaudeMd:
    file: CLAUDE.md
    template: templates/CLAUDE.md
    mentions:
      - perl-slop:reading-perl

CONFIGURATION

file

Required. The path of the file.

mentions

Required. The strings that the file must contain, such as the names of the skills that it tells an agent to load. An empty list asks only that the file exist.

template

The template that a person starts from, named in the update.

SEE ALSO

Please see those modules/websites for more information related to this module.

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/Troglodyne-Internet-Widgets/Dist-Conformance/issues

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

AUTHORS

Current Maintainers:

  • George S. Baugh <george@troglodyne.net>

COPYRIGHT AND LICENSE

Copyright (c) 2026 Troglodyne LLC

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.