Skip to content

docs: 저장소 위생(repo hygiene) 규약 추가 - #13

Merged
jeongph merged 4 commits into
mainfrom
feature/repo-hygiene
Jul 24, 2026
Merged

docs: 저장소 위생(repo hygiene) 규약 추가#13
jeongph merged 4 commits into
mainfrom
feature/repo-hygiene

Conversation

@jeongph

@jeongph jeongph commented Jul 24, 2026

Copy link
Copy Markdown
Member

제품(대개 OSS) 저장소에 인프라·운영 도구나 AI 세션 잡음을 넣지 않도록 하는 조직 규약을 rutter에 추가한다. 각 repo에 손으로 쓰는 대신 rutter가 소스가 되어 pilot apply로 배포한다(DRY·dogfood).

  • docs/conventions/repo-hygiene.md — 무엇을 빼고(ops 도구·세션 잡음) 무엇을 남기는지(CI·CLAUDE.md·ADR·Why). 설계 근거(Why)는 잡음이 아님을 명시
  • policies/core.yaml — PolicySet rule repo.hygiene (info) 추가

pilot package lint 통과 (PolicySet 2개 · rule 6개).

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added Korean-language repository hygiene guidance for product repositories.
    • Clarified which operational notes, temporary agent context, and local-only settings should be excluded.
    • Documented recommended repository content, including CI configuration, contributor guidance, and architectural decisions.
    • Included a contributor-facing decision checklist to help determine whether a file belongs in the repository.

@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@jeongph, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 40 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 65eb7aed-040f-407e-bbe1-e2f597287e31

📥 Commits

Reviewing files that changed from the base of the PR and between 5cd2f1b and e5470c0.

📒 Files selected for processing (1)
  • docs/conventions/shipshape.md
📝 Walkthrough

Walkthrough

Adds a Korean repository hygiene convention describing repository scope, excluded content, retained documentation, agent guidance files, and a contributor decision question.

Changes

Repository hygiene

Layer / File(s) Summary
Repository hygiene convention
docs/conventions/repo-hygiene.md
Defines repository content boundaries, including excluded operational and local-only materials, retained CI and architecture guidance, and criteria for deciding whether a file belongs in the repository.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding a repo hygiene convention document.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/repo-hygiene

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai 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.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@policies/core.yaml`:
- Around line 33-37: Scope the repo.hygiene rule to product repositories only by
moving it into a product-specific PolicySet or adding the supported per-rule
repository scope; ensure infrastructure and private operational repositories are
excluded while preserving the rule’s existing statement and rationale.
- Around line 33-37: Update the repo.hygiene policy entry to either add
supported path or pattern checks that enforce its repository-content
requirements, or explicitly mark/document the rule as advisory rather than
machine-enforced. Preserve the existing statement and rationale, and follow the
check/advisory conventions used by the other PolicySet entries.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d8427d01-9391-4e77-96f7-473ac3d0e2b2

📥 Commits

Reviewing files that changed from the base of the PR and between e6a18ad and f767161.

📒 Files selected for processing (2)
  • docs/conventions/repo-hygiene.md
  • policies/core.yaml

Comment thread policies/core.yaml Outdated
@jeongph
jeongph merged commit c8c6e03 into main Jul 24, 2026
2 checks passed
@jeongph
jeongph deleted the feature/repo-hygiene branch July 24, 2026 16:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant