From d65d248aca4c34ea1023fb2f6cac18c877f8e2f5 Mon Sep 17 00:00:00 2001 From: takeshi yamashita <220619+takecy@users.noreply.github.com> Date: Sat, 3 Oct 2026 12:00:17 +0900 Subject: [PATCH] docs(readme): align contributing guide with repository conventions Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01FXUFCzQvvR8h6rqDy3HenX --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index b981f0b..cac28ed 100644 --- a/README.md +++ b/README.md @@ -315,8 +315,8 @@ make build make test make lint -# Test manually with debug output -DEBUG=* go run gih/main.go status +# Run without building +go run ./gih status # Test with the development binary ./gih_dev status @@ -347,11 +347,11 @@ We welcome contributions! Here's how to get started: ### Pull Requests 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` 3. **Make** your changes with tests -4. **Run** the full test suite: `make test lint` -5. **Commit** your changes: `git commit -m 'Add amazing feature'` -6. **Push** to your branch: `git push origin feature/amazing-feature` +4. **Run** the full check: `make build && make test && make lint` +5. **Commit** your changes using [Conventional Commits](https://www.conventionalcommits.org/): `git commit -m 'feat(syncer): add amazing feature'` +6. **Push** to your branch: `git push origin feat/amazing-feature` 7. **Open** a Pull Request ### Code Style