Skip to content

chore: docs 기본 차단 (로컬 산출물 유출 방지) - #15

Merged
jeongph merged 2 commits into
mainfrom
chore/ignore-docs
Jul 28, 2026
Merged

chore: docs 기본 차단 (로컬 산출물 유출 방지)#15
jeongph merged 2 commits into
mainfrom
chore/ignore-docs

Conversation

@jeongph

@jeongph jeongph commented Jul 28, 2026

Copy link
Copy Markdown
Member

docs/ 차단이 .git/info/exclude(로컬 전용, 커밋되지 않음)에만 있어서 다른 사람이 clone하면 보호가 사라진다. 세션 의도 기록 같은 로컬 산출물이 공개 저장소에 올라갈 수 있어 .gitignore에 명시한다.

변경

.gitignore/docs/ 추가 — 기본 차단, 공개할 문서가 생기면 그때 명시적으로 허용(!/docs/<dir>/).

참고

rutter도 같은 원칙으로 정리(followingseas/rutter#16). wake는 이미 .gitignoredocs/가 있어 안전.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Chores
    • Updated repository exclusions to prevent local documentation and work artifacts from being included in public builds or commits, specifically ignoring everything under /docs/*.

@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 4c834efc-6974-4a9b-a76d-5367fa5b58f4

📥 Commits

Reviewing files that changed from the base of the PR and between c0eb160 and 67194c1.

📒 Files selected for processing (1)
  • .gitignore
🚧 Files skipped from review as they are similar to previous changes (1)
  • .gitignore

📝 Walkthrough

Walkthrough

The .gitignore file now excludes files under /docs/* and includes Korean comments explaining local generated artifacts and potential public-document exceptions.

Changes

Repository ignore rules

Layer / File(s) Summary
Exclude local documentation outputs
.gitignore
Adds /docs/* to ignore files under docs/ and documents why content-level ignoring preserves potential !/docs/공개/ exceptions.

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 matches the main change: ignoring docs-generated local artifacts to prevent accidental commits.
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 chore/ignore-docs

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: 1

🤖 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 @.gitignore:
- Around line 5-7: Update the docs ignore rule in .gitignore from ignoring the
directory itself to ignoring its contents, then explicitly re-include the
approved docs/conventions and docs/maps directories and their files so those
public documents can be committed while other docs remain ignored.
🪄 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: ffb4a950-9123-4040-9d6e-4a37e3327b9a

📥 Commits

Reviewing files that changed from the base of the PR and between 3618d6d and c0eb160.

📒 Files selected for processing (1)
  • .gitignore

Comment thread .gitignore Outdated
디렉토리(`/docs/`)를 무시하면 git 이 그 안으로 내려가지 않아, 이후
`!/docs/공개문서/` 같은 예외를 붙여도 무력해진다. 내용물(`/docs/*`)을
무시하는 형태로 바꿔 공개할 문서를 선택적으로 허용할 수 있게 한다.

CodeRabbit 지적 반영. 다만 제안된 `!/docs/conventions/`·`!/docs/maps/`
예외는 rutter 의 디렉토리 구조라 pilot 에는 없는 경로여서 넣지 않는다 —
공개할 문서가 생길 때 그 경로로 예외를 추가한다.
@jeongph

jeongph commented Jul 28, 2026

Copy link
Copy Markdown
Member Author

CodeRabbit 지적 반영했습니다 (67194c1).

진단은 정확합니다. /docs/ 로 디렉토리를 무시하면 git 이 그 안으로 내려가지 않아 이후 예외 규칙이 무력해집니다. 실제로 확인했습니다:

/docs/  + !/docs/public/   → docs/public/guide.md 노출 안 됨
/docs/* + !/docs/public/   → docs/public/guide.md 노출 ✓

제안된 예외 경로는 넣지 않았습니다. !/docs/conventions/·!/docs/maps/ 는 rutter 의 디렉토리 구조이고 pilot 에는 해당 디렉토리가 없습니다 (docs/ 자체가 없는 상태). 없는 경로를 미리 허용해두는 대신 /docs/* 로 문을 열어두고, 공개할 문서가 생길 때 그 경로로 예외를 추가하겠습니다.

@jeongph
jeongph merged commit d5e35d1 into main Jul 28, 2026
2 checks passed
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