Skip to content

Document release and master branches in README #272

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

Open
gene1wood wants to merge 2 commits into
base: 5.0.x
Choose a base branch
from
Open

Document release and master branches in README #272

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f746e0c
Document release and master branches in README
gene1wood Sep 30, 2025
59146eb
Clarify the branches further based on comments in #265
gene1wood Sep 30, 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
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,28 @@ This is a mature project that is only being maintained for bug fixes and
compatibility with new versions of Python. It is not under active development,
though we will try to respond to issues and pull requests.

## Branches

The default branch of this repository is the [`release` branch](https://github.com/DiffSK/configobj/tree/release),
rather than the [`master` branch](https://github.com/DiffSK/configobj/tree/master).
This decision dates back to when this project moved from being actively
maintained to its current state as a mature project.
At that time (in 2023), [changes introduced](https://github.com/DiffSK/configobj/compare/v5.0.6...master)
into the `master` branch had not been fully integrated, and the tooling had
shifted in ways that made [continuing from `master` unclear](https://github.com/DiffSK/configobj/pull/237#issuecomment-1925401612).

Instead, [we chose to continue development](https://github.com/DiffSK/configobj/issues/213#issuecomment-1377686121)
from the `5.0.6` release branch. Any changes made to `master` after that release
were effectively abandoned, and the [`release` branch](https://github.com/DiffSK/configobj/tree/release) has served as
the main line of development since.

As a result, going forward :

* Pull requests for feature changes / refactoring should be made against the `master` branch
* Pull requests for bug fixes should be made against the [`5.0.x`](https://github.com/DiffSK/configobj/tree/5.0.x)
branch. Those changes, once merged into [`5.0.x`](https://github.com/DiffSK/configobj/tree/5.0.x), will later be
merged into the [`master`](https://github.com/DiffSK/configobj/tree/master) branch.

## Past and Current Contributors:

- [Michael Foord](https://agileabstractions.com/)
Expand Down