docs: add CONTRIBUTING.md aligning with the BitBox-stack workflow#22
Merged
Conversation
Documents the branching model (develop default), the local PR gate (matches pull-request.yaml exactly), the release flow (auto-release-pr + auto-tag), and the hardware-wallet-specific rules contributors keep asking about — recoverPanic on every gomobile-exported entry point, the BLE-dedup contract in Bluetooth.swift, no print() in lib/ but ok in example/lib/. Mirrors the structure of bitbox-testkit's CONTRIBUTING.md adapted to Flutter-plugin context. Cross-references TESTING.md for the test-layer discussion instead of duplicating it.
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
bitbox-testkit has a CONTRIBUTING.md, bitbox_flutter didn't. Closes that consistency gap.
The doc covers what people repeatedly stumble over without it:
developdefault, every PR againstdevelop, release PR is auto-opened.recoverPanicon every gomobile-exported entry point, the BLE-dedup contract inBluetooth.swift,print()policy (banned inlib/, ok inexample/lib/).Cross-references TESTING.md for the test-layer pyramid instead of duplicating it. Mirrors bitbox-testkit's CONTRIBUTING.md structure, adapted to Flutter-plugin context.
Local validation
dart format --set-exit-if-changedflutter analyzeflutter test