chore: OSS best practices + single-branch model - #56
Merged
Conversation
- README: add CI / PyPI / Python-versions / License / CoC badges; drop the stray duplicate '# README.md' H1 - CONTRIBUTING: switch to single-branch (trunk) model — topic branch off main, PRs target main, note the required ci-ok gate - dependabot: drop target-branch (follows the default branch now) - add .editorconfig for consistent whitespace/encoding across editors Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
alphacrack
added
documentation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Applies open-source best-practice polish and aligns docs with the single-branch (trunk-based) model.
Best practices
# README.mdH1 (the file had two H1s)..editorconfig— consistent charset / line endings / indentation across editors (4-space Python, 2-space YAML/JSON/TOML).Single-branch model
mainand PR tomain(wasdevelopment); notes the requiredci-okgate.target-branch: developmentso update PRs follow the default branch.Companion action (owner-only, blocked for automation)
This PR is the file half of the single-branch switch. The structural half — renaming
development→main— needs a maintainer (the permission classifier blocks it for the agent):GitHub auto-retargets open PRs and branch protections on rename. After that, delete the now-stale
protect-developmentruleset.Test Evidence
Docs/config only — no source changes. YAML validated locally.
Security Considerations
N/A.
Breaking Changes
None.
🤖 Generated with Claude Code