docs: refine project docs and formatting conventions#336
Conversation
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7dcffe9157
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 003944fc80
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| } | ||
|
|
||
| spotless { | ||
| ratchetFrom 'origin/develop' |
There was a problem hiding this comment.
The PR workflow still runs for both develop and main targets (.github/workflows/pr-run-test.yml:5), but this hard-codes the Spotless ratchet to origin/develop. Spotless ratcheting checks files changed since the configured ref (docs), so PRs targeting main will be checked against the develop diff instead of their base branch once those branches diverge, causing unrelated formatting failures or the wrong baseline. Make the ratchet reference match the PR base branch, or restrict this workflow/config to develop only.
Useful? React with 👍 / 👎.
1 participant
Summary
README를 외부 방문자용 프로젝트 소개로 정리하고, AI 작업용 컨텍스트와 저장소 컨벤션 문서를 재구성했습니다. Java 포맷 기준으로 Spotless + google-java-format AOSP 설정도 추가했습니다.
Problem
기존 문서에는 미션 기반 학습 워크플로우가 전면에 남아 있어 현재 프로젝트 소개 목적과 맞지 않았습니다. 또한 브랜치/커밋/PR 작성 형식과 Java 포맷 기준이 명확히 정의되어 있지 않아 AI 작업이나 PR 작성 시 일관성을 유지하기 어려웠습니다.
Solution
미션 워크플로우 문서를 제거하고 README, AGENTS, docs 문서 구조를 역할별로 분리했습니다.
docs/templates/repository-conventions.md에 저장소 컨벤션을 정의하고, Spotless를 도입해 Java 포맷 검사를 자동화했습니다.Changes
.editorconfig추가spotlessCheck test실행하도록 변경Example
포맷 검사:
포맷 자동 적용:
전체 검증:
Related Issues
없음
Validation
./gradlew spotlessCheck./gradlew check