Skip to content

chore: introduce develop branch workflow #2

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
Mattarek merged 1 commit into from
Nov 7, 2026
Merged

chore: introduce develop branch workflow #2

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ name: CI

on:
push:
branches: [ main ]
branches: [ main, develop ]
pull_request:
branches: [ main ]
branches: [ main, develop ]

permissions:
contents: read
Expand Down
17 changes: 13 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,20 @@ src

## Development workflow

This project follows **trunk-based development**:
```
feature branch ──PR (squash)──▶ develop ──PR (senior review, merge commit)──▶ main
```

| Branch | Purpose |
|-------------|---------------------------------------------------------------|
| `main` | Reviewed, stable code. Updated only from `develop`. |
| `develop` | Integration branch. All feature branches are merged here. |
| `<type>/…` | Short-lived work branch created from `develop`. |

- `main` is always releasable — it must build and pass all tests.
- Every change goes through a short-lived branch and a Pull Request.
- Every change starts from an up-to-date `develop` and goes through a Pull Request.
- Feature → `develop`: **squash and merge**, branch deleted afterwards.
- `develop` → `main`: reviewed by a senior developer, merged with a **merge commit**.
- CI must pass before any merge.
- Branch naming: `<type>/<short-description>`, e.g. `feat/user-registration`.
- Commit messages follow [Conventional Commits](https://www.conventionalcommits.org/):
`feat`, `fix`, `docs`, `refactor`, `test`, `build`, `ci`, `chore`.
- Pull Requests are merged with **squash and merge** and the branch is deleted afterwards.
Loading