docs: add gauge-repo engineering best-practices audit - #71
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The new audit doc contains at least one broken repo-relative reference and an inconsistent default-branch statement that should be corrected to keep the audit accurate.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds a new engineering best-practices audit document for the query_helper repository (gauge-repo / PXM catalog batch) to capture current compliance status, critical gate outcomes, and prioritized recommendations.
Changes:
- Introduces
docs/engineering-best-practices-audit.mdwith scorecard, per-category breakdown, and itemized evidence/recommendations. - Records critical gate status (AGENTS.md + required CI checks) and a prioritized action list.
File summaries
| File | Description |
|---|---|
| docs/engineering-best-practices-audit.md | New audit report documenting current best-practices compliance, evidence, and prioritized remediations. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 3
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| @@ -0,0 +1,163 @@ | |||
| # Engineering Best Practices Audit — query_helper | |||
|
|
|||
| | | | | |||
| |---|---| | ||
| | **Audit date** | 2026-09-08 | | ||
| | **Auditor** | Claude — gauge-repo skill | | ||
| | **Rubric version** | `item-credit-v1` — 2026-09-04 (`references/best-practices.md`) | |
| | **Critical gates** | **RED** | | ||
| | **Adjusted compliance** | **34.7%** | | ||
|
|
||
| Critical gate 2 (AGENTS.md) is Gap and gate 16 (required CI checks before merge) is Partial — the org `require-pr-review` ruleset enforces review on `master` but does not require the existing CI/Brakeman workflows as merge status checks. Adjusted compliance is calculated independently: |
Naman Sharma (ns1306)
approved these changes
Sep 9, 2026
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.
Summary
Adds the gauge-repo engineering best-practices audit for
query_helperatdocs/engineering-best-practices-audit.md(PXM catalog batch).require-pr-reviewruleset requires review but does not require the existing CI/Brakeman jobs as merge status checks.AGENTS.mdwith repo layout, test command, Ruby pin, and release flow.required_status_checksrule listing thetestandbrakemanjobs so red builds block merge..agents/pattern-agents.jsonwith GitHub repo, PXM ClickUp list, PXM Slack, and Datadog service metadata.Documentation only — no code changes.
Requested by: juili.chormole@pattern.com