Skip to content

Add contributing guide - #1

Merged
josef-poetzl merged 1 commit into
devfrom
feature/contributing-guide
Oct 12, 2026
Merged

josef-poetzl merged 1 commit into
devfrom
feature/contributing-guide

Conversation

@josef-poetzl

Copy link
Copy Markdown
Member

Summary

Adds CONTRIBUTING.md describing the branch model and release process, and links it from the README.

Branch model

  • feature/<name> / fix/<name> are created from dev and merged back into dev via pull request with Squash and merge (one commit per feature or fix).
  • No direct commits to main or dev.

Release process

  1. Update CHANGELOG.md and __version__ on dev (via a release/X.Y.Z branch and pull request).
  2. Pull request dev -> main, merged with Create a merge commit (no squash, so no merge back into dev is needed).
  3. Tag the merge commit on main (vX.Y.Z) and push only this tag.

Changes

  • CONTRIBUTING.md (new): branches, pull requests, release steps, development conventions (English, CRLF/UTF-8, integration tests only with copies in testdata\).
  • README.md: link to CONTRIBUTING.md in the "Development" section.

Documentation only – no code changes.

@josef-poetzl
josef-poetzl merged commit 19bd04f into dev Oct 12, 2026
2 checks passed
@josef-poetzl
josef-poetzl deleted the feature/contributing-guide branch October 12, 2026 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant