Skip to content

docs(readme): align contributing guide with repository conventions #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
takecy merged 1 commit into from
Oct 3, 2026
Merged

docs(readme): align contributing guide with repository conventions #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading