Skip to content

chore: establish develop branch workflow #25

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
merged 2 commits into from
Nov 22, 2025
Merged

chore: establish develop branch workflow #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
daa14f2
chore: implement develop branch workflow
Nov 19, 2025
74b78a7
fix: correct CI badge URL to use workflow file name
Nov 22, 2025
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
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@ on:
push:
branches:
- main
- develop
- "feat/**"
- "bugfix/**"
pull_request:
branches:
- main
- develop

# Cancel in-progress runs for the same workflow and branch
concurrency:
Expand Down
22 changes: 16 additions & 6 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,14 +124,19 @@ poetry run pytest

### 1. Create a Feature Branch

Always create a new branch for your work:
We use a **develop branch workflow**:
- `main` - Stable release branch (protected)
- `develop` - Active development integration branch
- Feature branches - Created from and merged back to `develop`

Always create a new branch for your work from `develop`:

```bash
# Update your main branch
git checkout main
git pull upstream main
# Update your develop branch
git checkout develop
git pull upstream develop

# Create a feature branch
# Create a feature branch from develop
git checkout -b feature/your-feature-name

# Or for bug fixes
Expand All @@ -145,6 +150,11 @@ Branch naming conventions:
- `refactor/description` - Code refactoring
- `test/description` - Test additions/improvements

**Workflow Summary**:
1. Feature branches are created from `develop`
2. Pull requests target `develop` (not `main`)
3. `main` receives periodic releases from `develop` via PR

### 2. Make Your Changes

Follow these guidelines when writing code:
Expand Down Expand Up @@ -386,7 +396,7 @@ git commit -m "test: add integration tests for tournaments"
git push origin feature/your-feature-name
```

Then create a pull request on GitHub with:
Then create a pull request on GitHub **targeting the `develop` branch** with:

1. **Clear title** describing the change
2. **Description** including:
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![PyPI version](https://img.shields.io/pypi/v/ifpa-api.svg)](https://pypi.org/project/ifpa-api/)
[![Python versions](https://img.shields.io/pypi/pyversions/ifpa-api.svg)](https://pypi.org/project/ifpa-api/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![CI](https://github.com/johnsosoka/ifpa-api-python/workflows/CI/badge.svg)](https://github.com/johnsosoka/ifpa-api-python/actions/workflows/ci.yml)
[![CI](https://github.com/johnsosoka/ifpa-api-python/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/johnsosoka/ifpa-api-python/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/johnsosoka/ifpa-api-python/branch/main/graph/badge.svg)](https://codecov.io/gh/johnsosoka/ifpa-api-python)
[![Documentation](https://img.shields.io/badge/docs-mkdocs-blue.svg)](https://johnsosoka.github.io/ifpa-api-python/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
Expand Down