Skip to content

docs: prefer shared Craft libraries for reusable features - #2178

Merged
dylanmtaylor merged 1 commit into
mainfrom
docs/shared-library-guidance
Nov 17, 2026
Merged

dylanmtaylor merged 1 commit into
mainfrom
docs/shared-library-guidance

Conversation

@dylanmtaylor

@dylanmtaylor dylanmtaylor commented Nov 16, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Add a concise shared-library-first guideline for formats, codecs, protocols and reusable UI.
  • Keep app policy/model mapping local and preserve behavior, security limits, attribution and tests.
  • Preserve all existing AGENTS.md content, line endings and generated house-rule blocks.

Validation

  • Verified this change only appends the shared-library section to AGENTS.md.
  • Verified remote content and the single-file diff.
  • No local build or runtime tests: documentation-only change; hosted checks may run.

Summary by CodeRabbit

  • Documentation
    • Added contributor guidance to check shared libraries before creating or changing reusable file-format, codec, protocol, or UI code. It also emphasizes preserving behavior, security, attribution, and regression coverage when adopting shared implementations.

@coderabbitai

coderabbitai Bot commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

AGENTS.md adds guidance to check storytold/craft-libs and its open PRs before changing reusable code. It also describes reuse preferences and safeguards for cutovers.

Changes: Shared Library Guidance

Layer / File(s) Summary
Add shared library guidance
AGENTS.md
Adds guidance to check shared libraries before changing file-format, codec, protocol, or reusable UI code. It prefers reuse or extension over local duplication and lists safeguards for cutovers.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Suggested reviewers: aiongg, echelon, fredapps

Merge Risk: Minimal · up to 9b50c

This is a documentation-only guideline addition with no runtime impact, and it is safe to merge.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "docs: prefer shared Craft libraries for reusable features" matches the change. The PR adds a Shared libraries rule to AGENTS.md (+4 lines, no code changes). The rule tells contributors to c…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "docs: prefer shared Craft libraries for reusable features" matches the change. The PR adds a Shared libraries rule to AGENTS.md (+4 lines, no code changes). The rule tells contributors to check storytold/craft-libs and its open PRs before adding or changing file-format, codec, protocol, or reusable UI code, and to reuse or extend shared libraries instead of duplicating code. The title names the main change and the docs type. It is concise and specific.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

Commits

Reviewing files that changed from the base of the PR and between 3b6f9e7 and 9b50c07.

Files selected for processing: 1

  • AGENTS.md

Included review availability: This review used your included allowance. Your plan provides up to 8 included reviews per hour; 7 remain after this review.

@autocraft-bot autocraft-bot Bot added the infra Tests, CI, docs, build, packaging, tooling label Nov 16, 2026
@sonarqubecloud

Copy link
Copy Markdown

@autocraft-bot autocraft-bot Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

AI-generated review (Opus). Not a maintainer decision.

No blocking problems found.

Claims checked:

  • verified: The change only appends a shared-library section to AGENTS.md and keeps all existing content, including the generated house-rule blocks. (The diff has a single hunk after AGENTS.md:241 that adds four lines (a blank line, the heading, a blank line and the paragraph) and removes nothing. The house-ru…
  • verified: The guidance says to check shared libraries first for formats, codecs, protocols and reusable UI, while keeping app policy and model mapping local and preserving behaviour, security limits, attribution and tests. (withheld)

Reviewed at 9b50c07.

Recommendation: merge, after a maintainer's decision.

@FredApps FredApps left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Reviewed 9b50c07. The full diff only appends the Shared libraries section to AGENTS.md; existing repository instructions and generated house-rule blocks are unchanged. Checking craft-libs and open PRs before implementing reusable code aligns with #778, while explicitly retaining app policy/model mapping, security/resource limits, attribution and regression coverage. I checked the surrounding repository instructions and shared guidance; this does not relax clean-room, layering, dependency licensing or validation requirements. No blocking documentation finding.

Validation: current-head hosted CI gate, house-rules check and Sonar checks passed. No local build or runtime tests run for this documentation-only change.

The existing permission to copy from sibling apps is not a requirement to duplicate shared libraries; the new shared-library-first direction and preserved app-specific boundary are compatible.

@dylanmtaylor
dylanmtaylor merged commit f964d06 into main Nov 17, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

infra Tests, CI, docs, build, packaging, tooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants