Docs: contributor + project-meta scaffolding - #37
Merged
Conversation
Rounds out the OSS hygiene the review flagged as missing: - .gitignore — build output (host + arduino-cli), release artifacts, downloaded tooling (uf2conv), editor/OS junk. Verified it shadows nothing already tracked. - CONTRIBUTING.md — build (IDE + arduino-cli), host test + clang-tidy commands, the focused-branch/one-PR workflow, and the project's hard-won conventions (no String in hot paths, SD mutex, never analogRead, TIMER3 reserved). - SECURITY.md — private vulnerability reporting via GitHub advisories, attack-surface scope, and an honest 'known posture' note that BLE is currently unauthenticated (Pin Lock is roadmap). - ARCHITECTURE.md — human-facing narrative of the subsystems and the why behind the non-obvious parts (GPS ring buffer / TIMER3, SD arbitration across the BLE task, DOVEX crash safety, EMI hardening, GPS V_BCKP recovery). Points to CLAUDE.md for exhaustive detail. - .github/ISSUE_TEMPLATE/ (bug + feature, blank issues off, security routed to private advisories) and PULL_REQUEST_TEMPLATE.md. - README: Contributing section + tidied License/Support, all linking the new docs. CODE_OF_CONDUCT.md is referenced (CONTRIBUTING, README, issue config) but intentionally not included here — it will be added separately.
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
2 participants
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.
PR #6 — the final piece of the path to 8/10. Project-meta and contributor scaffolding, the OSS hygiene the original review flagged as missing.
What's added
.gitignoreuf2conv), editor/OS junk. Verified it shadows nothing already tracked.CONTRIBUTING.mdStringin hot paths, SD mutex, neveranalogRead,TIMER3reserved).SECURITY.mdARCHITECTURE.mdCLAUDE.mdfor exhaustive detail rather than duplicating the constant tables..github/ISSUE_TEMPLATE/.github/PULL_REQUEST_TEMPLATE.mdREADME.mdOn the Code of Conduct
CODE_OF_CONDUCT.mdis referenced (from CONTRIBUTING, README, and the issue config) but intentionally not included in this PR — you're adding it separately. Once it's in, every reference resolves; until then they're dead links to a file that's coming.Notes
.gitignorechecked against the tracked file list so nothing tracked gets shadowed.That's the playbook complete for this repo
After this merges (plus your CODE_OF_CONDUCT.md), DovesDataLogger has: a clean module structure, a host test suite, static analysis, a security fix + policy, a release pipeline, and full contributor docs. That's the 8/10 bar. Same playbook is ready to point at the dataviewer next.
🤖 Generated with Claude Code
Generated by Claude Code