docs(readme): align contributing guide with repository conventions - #32
Merged
Merged
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01FXUFCzQvvR8h6rqDy3HenX
takecy
force-pushed
the
docs/readme-dev-guide
branch
from
October 3, 2026 03:29
290425d to
d65d248
Compare
takecy
marked this pull request as ready for review
October 3, 2026 03:31
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The branch creation step still omits the mandatory .worktrees/ workflow.
Review effort: Balanced
Findings: 1
Open (1)
What changed in this PR
Aligns README contribution instructions with repository conventions.
Changes:
- Corrects the development run command.
- Documents branch naming and Conventional Commits.
- Updates required pre-PR checks.
| File | Description |
|---|---|
| README.md | Updates development and contribution guidance. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
|
||
| 1. **Fork** the repository | ||
| 2. **Create** a feature branch: `git checkout -b feature/amazing-feature` | ||
| 2. **Create** a branch prefixed with the change type (`feat/`, `fix/`, `docs/`, ...): `git checkout -b feat/amazing-feature` |
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.
Issue
Overview
README の開発手順に、効果の無い記述と、リポジトリ規約（AGENTS.md）と矛盾する記述が残っていたので修正します。README の変更のみで、動作の変更はありません。
Development Workflow
DEBUG=* go run gih/main.go status→go run ./gih statusDEBUG環境変数を読む箇所は無く、指定しても効果がありませんでしたContributing > Pull Requests
feature/amazing-feature→feat/amazing-feature（変更の種類をプレフィックスにする旨を追記）make test lint→make build && make test && make lint（AGENTS.md の PR 前チェックと一致させました）'Add amazing feature'→'feat(syncer): add amazing feature'（Conventional Commits へのリンクを追加）確認事項
go run ./gih --helpが動くことを確認済みですmake build/make test/make lintが通ることを確認済みですgih checkout -b feature/newは gih の使い方の例（利用者自身のリポジトリでの操作）なので、変更していません🤖 Generated with Claude Code
https://claude.ai/code/session_01FXUFCzQvvR8h6rqDy3HenX