Skip to content

docs: CLAUDE.md governance cleanup - #14

Merged
joshsmithxrm merged 1 commit into
mainfrom
docs/cleanup-staging
Jan 14, 2026
Merged

docs: CLAUDE.md governance cleanup#14
joshsmithxrm merged 1 commit into
mainfrom
docs/cleanup-staging

Conversation

@joshsmithxrm

Copy link
Copy Markdown
Owner

Summary

  • Trim CLAUDE.md to <100 lines per governance rules

Test plan

  • Verify CLAUDE.md is <100 lines
  • Verify PowerShell module imports correctly

🤖 Generated with Claude Code

Reduces CLAUDE.md from 307 to 50 lines per governance standards:
- Top 5 NEVER/ALWAYS rules only
- Removed PowerShell code examples
- Removed module structure pattern
- Removed Pester test examples
- Kept cmdlet table with CLI command mappings

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings January 14, 2026 14:46
@gemini-code-assist

Copy link
Copy Markdown

Summary of Changes

Hello @joshsmithxrm, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request streamlines the CLAUDE.md documentation by removing verbose details and focusing on essential guidelines and references. The primary goal is to make the document more concise and easier to digest, ensuring it adheres to a specified governance rule regarding document length.

Highlights

  • Documentation Trimming: The CLAUDE.md file has been significantly reduced in length, from 306 lines to 50 lines, to comply with governance rules requiring documents to be under 100 lines.
  • Content Refocus: Extensive sections detailing project structure, development workflow, version management, release processes, testing patterns, and dependencies have been removed. The document now focuses on core NEVER and ALWAYS rules, a concise list of cmdlets and their corresponding CLI commands, common commands, and key file references.
  • Title Update: The main title of the document has been updated from "# CLAUDE.md - ppds-tools" to "# PPDS Tools" for brevity and clarity.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request simplifies the CLAUDE.md developer guide to make it more concise. While the goal of brevity is good, the current changes have resulted in the removal of some important development guidelines and have introduced inaccuracies, particularly in the list of available cmdlets. My review focuses on restoring this critical information to ensure the document remains a reliable and complete resource for developers, while still respecting the goal of conciseness. The suggested additions will not significantly increase the file size and will keep it well under the 100-line limit.

Comment thread CLAUDE.md
Comment thread CLAUDE.md
Comment thread CLAUDE.md
Comment thread CLAUDE.md

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR trims CLAUDE.md from 306 lines to 50 lines to comply with governance rules requiring the file to be under 100 lines. The document has been restructured to focus on essential information while removing verbose explanations, examples, and detailed sections.

Changes:

  • Condensed NEVER/ALWAYS rules from detailed tables to simple bullet lists
  • Simplified cmdlets table to show only 6 cmdlets (reduced from 12)
  • Removed sections on tech stack, project structure, development workflow, testing patterns, version management, release process, and dependencies
  • Converted key files and commands sections to concise lists

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread CLAUDE.md
@joshsmithxrm
joshsmithxrm merged commit 511b22b into main Jan 14, 2026
9 checks passed
@joshsmithxrm
joshsmithxrm deleted the docs/cleanup-staging branch January 14, 2026 15:00
@github-project-automation github-project-automation Bot moved this from Todo to Done in PPDS Roadmap Jan 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants