Skip to content
Merged
Changes from all commits
Commits
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
142 changes: 142 additions & 0 deletions .bestpractices.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,142 @@
{
"name": "Lagebuch",
"homepage_url": "https://github.com/CodeForFire/lagebuch",
"repo_url": "https://github.com/CodeForFire/lagebuch",
"license": "MIT",
"implementation_languages": "C#, Shell, Makefile, Dockerfile",
"description": "Offline-first incident documentation (Einsatzdokumentation) for fire brigades. A .NET/Avalonia desktop application for the command vehicle (ELW) with an Android companion: incident log, resource and personnel tracking, breathing-apparatus monitoring with spoken alarms, CO measurement protocol, checklists and a PDF report. Each incident is a single local .fwincident SQLite file; optional multi-device sync runs over the local network with TLS and certificate pinning. No cloud, no account, no telemetry.",
"description_good_status": "Met",
"description_good_justification": "The README opens with what the software is, who it is for and why, in German for the fire-brigade audience, with an English developer section below: https://github.com/CodeForFire/lagebuch/blob/main/README.md",
"interact_status": "Met",
"interact_justification": "GitHub Discussions with four German categories (Ankündigungen, Fragen & Antworten, Ideen, Aus der Praxis): https://github.com/CodeForFire/lagebuch/discussions. Issue templates route bugs and features: https://github.com/CodeForFire/lagebuch/tree/main/.github/ISSUE_TEMPLATE",
"contribution_status": "Met",
"contribution_justification": "CONTRIBUTING.md, linked from the README, covers setup, workflow, commit conventions and how to pick a first issue: https://github.com/CodeForFire/lagebuch/blob/main/CONTRIBUTING.md",
"contribution_requirements_status": "Met",
"contribution_requirements_justification": "CONTRIBUTING.md requires Conventional Commits, DCO sign-off, green CI, a CHANGELOG entry for src/ changes, before/after screenshots for UI changes, and no real master data: https://github.com/CodeForFire/lagebuch/blob/main/CONTRIBUTING.md",
"floss_license_status": "Met",
"floss_license_justification": "MIT: https://github.com/CodeForFire/lagebuch/blob/main/LICENSE",
"floss_license_osi_status": "Met",
"floss_license_osi_justification": "MIT is OSI-approved.",
"license_location_status": "Met",
"license_location_justification": "https://github.com/CodeForFire/lagebuch/blob/main/LICENSE at the repository root.",
"documentation_basics_status": "Met",
"documentation_basics_justification": "README covers installation per platform, a five-minute guided first run with sample data, and each module: https://github.com/CodeForFire/lagebuch/blob/main/README.md. Master data format: https://github.com/CodeForFire/lagebuch/blob/main/docs/master-data.md. Releasing: https://github.com/CodeForFire/lagebuch/blob/main/docs/releasing.md",
"documentation_interface_status": "Met",
"documentation_interface_justification": "The external interfaces are the desktop UI, the .fwincident file and the master-data JSON. The JSON schema is documented prose-and-example in https://github.com/CodeForFire/lagebuch/blob/main/docs/master-data.md with a complete reference file at https://github.com/CodeForFire/lagebuch/blob/main/docs/master-data.example.json. The UI is documented per module with screenshots in the README.",
"sites_https_status": "Met",
"sites_https_justification": "The project site is the GitHub repository, served over HTTPS: https://github.com/CodeForFire/lagebuch",
"discussion_status": "Met",
"discussion_justification": "GitHub Discussions: https://github.com/CodeForFire/lagebuch/discussions",
"english_status": "Met",
"english_justification": "Developer documentation, issues, pull requests, commit messages and code comments are English. The end-user interface is German by design, because the users are German fire brigades.",
"maintained_status": "Met",
"maintained_justification": "Six releases between 2026-07 and 2026-09 and commits most days: https://github.com/CodeForFire/lagebuch/releases and https://github.com/CodeForFire/lagebuch/commits/main",
"repo_public_status": "Met",
"repo_public_justification": "Public git repository: https://github.com/CodeForFire/lagebuch",
"repo_track_status": "Met",
"repo_track_justification": "git, so every change has an author, a timestamp and a parent.",
"repo_interim_status": "Met",
"repo_interim_justification": "Every change reaches main through a pull request, so interim work is public on branches and in the PR before it is released: https://github.com/CodeForFire/lagebuch/commits/main",
"repo_distributed_status": "Met",
"repo_distributed_justification": "git.",
"version_unique_status": "Met",
"version_unique_justification": "Each release has a unique vX.Y.Z tag and a matching GitHub release: https://github.com/CodeForFire/lagebuch/releases",
"version_semver_status": "Met",
"version_semver_justification": "Semantic Versioning. The project is pre-1.0 and the changelog says plainly that breaking changes may occur in any release until then; ROADMAP.md defines what 1.0 commits to: https://github.com/CodeForFire/lagebuch/blob/main/ROADMAP.md",
"version_tags_status": "Met",
"version_tags_justification": "Tags of the form vX.Y.Z, currently through v0.5.0: https://github.com/CodeForFire/lagebuch/tags",
"release_notes_status": "Met",
"release_notes_justification": "CHANGELOG.md follows Keep a Changelog 1.1.0 and each GitHub release carries human-readable notes derived from it, not a raw commit log: https://github.com/CodeForFire/lagebuch/blob/main/CHANGELOG.md",
"release_notes_vulns_status": "N/A",
"release_notes_vulns_justification": "No vulnerability has been reported or fixed in the project to date, so no release note has had to identify one. The changelog keeps a Security section for when that changes.",
"report_process_status": "Met",
"report_process_justification": "CONTRIBUTING.md explains how to report a bug, and the issue templates ask for version, platform, steps and expected versus actual behaviour: https://github.com/CodeForFire/lagebuch/tree/main/.github/ISSUE_TEMPLATE",
"report_tracker_status": "Met",
"report_tracker_justification": "GitHub Issues: https://github.com/CodeForFire/lagebuch/issues",
"report_responses_status": "Met",
"report_responses_justification": "Every issue opened so far has been responded to and the large majority closed: https://github.com/CodeForFire/lagebuch/issues?q=is%3Aissue",
"enhancement_responses_status": "Met",
"enhancement_responses_justification": "Feature requests are answered in the issue and, when accepted, placed in a roadmap milestone: https://github.com/CodeForFire/lagebuch/milestones",
"report_archive_status": "Met",
"report_archive_justification": "GitHub Issues and Discussions are publicly readable and permanently archived: https://github.com/CodeForFire/lagebuch/issues",
"vulnerability_report_process_status": "Met",
"vulnerability_report_process_justification": "SECURITY.md documents the process and is linked from the README, CONTRIBUTING.md and the issue-template chooser: https://github.com/CodeForFire/lagebuch/blob/main/SECURITY.md",
"vulnerability_report_private_status": "Met",
"vulnerability_report_private_justification": "GitHub private vulnerability reporting via the Security tab. SECURITY.md gives step-by-step instructions and states explicitly that vulnerabilities must not go in public issues, discussions or pull requests: https://github.com/CodeForFire/lagebuch/blob/main/SECURITY.md",
"vulnerability_report_response_status": "N/A",
"vulnerability_report_response_justification": "No vulnerability has been reported in the last six months, which is the case the criterion says to answer N/A for.",
"build_status": "Met",
"build_justification": "dotnet build, wrapped by a Makefile, with the SDK version pinned in global.json: https://github.com/CodeForFire/lagebuch/blob/main/Makefile",
"build_common_tools_status": "Met",
"build_common_tools_justification": "The .NET SDK and MSBuild, both widely used and freely available.",
"build_floss_tools_status": "Met",
"build_floss_tools_justification": "The .NET SDK is MIT-licensed FLOSS and the build runs on Linux in CI. The optional Android head additionally needs the Android SDK; a Docker-based build is provided so that head can be built with FLOSS tooling too.",
"test_status": "Met",
"test_justification": "126 test files and roughly 1,100 test methods across eight xUnit projects, including a headless Avalonia render suite that exercises real views: https://github.com/CodeForFire/lagebuch/tree/main/tests",
"test_invocation_status": "Met",
"test_invocation_justification": "dotnet test, or make test, optionally narrowed with PROJECT= and FILTER=.",
"test_most_status": "Met",
"test_most_justification": "Coverage is collected on every CI run and summarised into the job summary: https://github.com/CodeForFire/lagebuch/blob/main/.github/workflows/ci.yml",
"test_continuous_integration_status": "Met",
"test_continuous_integration_justification": "GitHub Actions builds and tests on Ubuntu and Windows for every push and pull request: https://github.com/CodeForFire/lagebuch/blob/main/.github/workflows/ci.yml",
"test_policy_status": "Met",
"test_policy_justification": "CONTRIBUTING.md and AGENTS.md require tests with new functionality and the pull-request template carries the checklist: https://github.com/CodeForFire/lagebuch/blob/main/CONTRIBUTING.md",
"tests_are_added_status": "Met",
"tests_are_added_justification": "Recent feature pull requests add tests alongside the code. The README screenshots and the sample incident file are themselves produced by tests, so they cannot drift from the application: https://github.com/CodeForFire/lagebuch/pulls?q=is%3Apr+is%3Amerged",
"tests_documented_added_status": "Met",
"tests_documented_added_justification": "The policy is written down in CONTRIBUTING.md: https://github.com/CodeForFire/lagebuch/blob/main/CONTRIBUTING.md",
"warnings_status": "Met",
"warnings_justification": "Directory.Build.props sets AnalysisMode=All and AnalysisLevel=10.0, enables nullable reference types and adds StyleCop.Analyzers to every project. CI additionally runs dotnet format in whitespace and style modes with --verify-no-changes: https://github.com/CodeForFire/lagebuch/blob/main/Directory.Build.props",
"warnings_fixed_status": "Met",
"warnings_fixed_justification": "TreatWarningsAsErrors=true, so any warning fails the build and therefore the pull request. There is no backlog of tolerated warnings. The only suppression is CS1591 (missing XML doc comment); the two disabled analyzer rules, CA2007 and CA1716, each carry a written rationale in .editorconfig, and no CA3xxx or CA5xxx security rule is suppressed anywhere.",
"warnings_strict_status": "Met",
"warnings_strict_justification": "Warnings are errors, analysis mode is the strictest setting rather than the default subset, and the format checks are enforced in CI rather than advisory.",
"know_secure_design_status": "Met",
"know_secure_design_justification": "The maintainer has a long background in open-source infrastructure software and handles security advisories for it. In this project that shows as least privilege by default in CI, a deliberate removal of the accept-any-certificate fallback in the sync client so there is no way to skip verification, and a threat model in SECURITY.md that names its own limitations rather than hiding them: https://github.com/CodeForFire/lagebuch/blob/main/SECURITY.md",
"know_common_errors_status": "Met",
"know_common_errors_justification": "Input from outside the trust boundary is treated as hostile: attachment file names are sanitised before use, the Android FileProvider is deliberately scoped, and the PIN gate sits in middleware ahead of routing so no endpoint can be reached around it. Parameterised SQL throughout, nullable reference types enabled, and CodeQL's security-and-quality suite on every pull request: https://github.com/CodeForFire/lagebuch/blob/main/.github/workflows/codeql.yml",
"crypto_published_status": "Met",
"crypto_published_justification": "Only published, standardised algorithms: TLS as negotiated by the platform, ECDSA on NIST P-256, SHA-256. Nothing proprietary and nothing secret.",
"crypto_call_status": "Met",
"crypto_call_justification": "The project implements no cryptography of its own. Everything is delegated to .NET's System.Security.Cryptography and the platform TLS stack through Kestrel and HttpClientHandler.",
"crypto_floss_status": "Met",
"crypto_floss_justification": "The .NET runtime and its cryptographic libraries are MIT-licensed FLOSS, and the platform TLS implementation is the operating system's.",
"crypto_keylength_status": "Met",
"crypto_keylength_justification": "ECDSA on NIST P-256, a 128-bit security level, well above the 112-bit minimum. Certificates are signed with SHA-256.",
"crypto_working_status": "Met",
"crypto_working_justification": "No broken algorithm is used. There is no MD5, no SHA-1 and no DES anywhere. Verified by inventorying every System.Security.Cryptography call site in src/, of which there are three.",
"crypto_weaknesses_status": "Met",
"crypto_weaknesses_justification": "The same inventory shows nothing from the deprecated list. Certificate fingerprints and signatures are SHA-256.",
"crypto_pfs_status": "Met",
"crypto_pfs_justification": "TLS 1.2 and 1.3 as negotiated by the platform, with an ECDSA certificate, so the key exchange is ECDHE and provides forward secrecy.",
"crypto_password_storage_status": "N/A",
"crypto_password_storage_justification": "The software has no user accounts and no login, so it stores no passwords for authenticating external users and this criterion has nothing to apply to. To pre-empt the obvious question: there is one shared secret, a four-digit PIN that gates joining a sync session. It is generated per session with the platform cryptographically secure generator, exists only in memory, is never written to disk and is discarded when the session ends, so it is never stored and could not be stored as a salted iterated hash. It is transmitted only inside TLS, and brute force is answered by per-source-IP exponential backoff in middleware ahead of routing rather than by a longer secret. SECURITY.md states plainly that the PIN plus network reachability is the whole access-control boundary: https://github.com/CodeForFire/lagebuch/blob/main/SECURITY.md",
"crypto_random_status": "Met",
"crypto_random_justification": "The share PIN, the one security-relevant random value, is generated with RandomNumberGenerator.GetInt32, the platform cryptographically secure generator. System.Random does not appear anywhere in src/ or tests/. The remaining randomness is Guid.NewGuid for entity identifiers and temporary directory names, which is not key or nonce material.",
"delivery_mitm_status": "Met",
"delivery_mitm_justification": "Releases are downloaded from GitHub over HTTPS: https://github.com/CodeForFire/lagebuch/releases",
"delivery_unsigned_status": "Met",
"delivery_unsigned_justification": "The criterion forbids retrieving a cryptographic hash over plain HTTP and trusting it without a signature. The project publishes no checksums at all today and every download is over HTTPS, so no such retrieval happens. Checksums and build attestations are planned, and will be served over HTTPS alongside the packages.",
"vulnerabilities_fixed_60_days_status": "Met",
"vulnerabilities_fixed_60_days_justification": "No vulnerability has been reported, so nothing of medium or higher severity is unpatched. Dependabot runs weekly over five update configurations covering three ecosystems, GitHub Actions, Docker and NuGet, the last across three separate package directories: https://github.com/CodeForFire/lagebuch/blob/main/.github/dependabot.yml. CodeQL additionally runs on every pull request.",
"vulnerabilities_critical_fixed_status": "Met",
"vulnerabilities_critical_fixed_justification": "There are no known unpatched vulnerabilities of any severity.",
"no_leaked_credentials_status": "Met",
"no_leaked_credentials_justification": "No key, certificate or credential file is committed anywhere, and there are no hardcoded secrets in src/. Certificates used in tests are generated at runtime. Real master data is treated as personal data: seed-source/ and *.masterdata.json are gitignored, and the only tracked master data is an anonymised example.",
"static_analysis_status": "Met",
"static_analysis_justification": "Two independent tools. CodeQL with the security-and-quality suite runs on every pull request, every push to main and weekly, with results in the repository's Code Scanning tab: https://github.com/CodeForFire/lagebuch/blob/main/.github/workflows/codeql.yml. Separately the build itself enforces the .NET analyzers at AnalysisMode=All plus StyleCop, with warnings as errors: https://github.com/CodeForFire/lagebuch/blob/main/Directory.Build.props",
"static_analysis_common_vulnerabilities_status": "Met",
"static_analysis_common_vulnerabilities_justification": "CodeQL's security-and-quality suite is explicitly vulnerability-focused, and no CA3xxx injection or CA5xxx security analyzer rule is suppressed in the build.",
"static_analysis_fixed_status": "Met",
"static_analysis_fixed_justification": "There are no outstanding CodeQL alerts; the first full run on the default branch reported none. Analyzer findings cannot accumulate at all, because TreatWarningsAsErrors turns them into build failures.",
"static_analysis_often_status": "Met",
"static_analysis_often_justification": "On every pull request and every push to main, plus a weekly scheduled run so that newly released queries reach existing code even when the repository is quiet.",
"dynamic_analysis_status": "Unmet",
"dynamic_analysis_justification": "No fuzzing or runtime instrumentation today. The place it would matter first is the .fwincident and master-data JSON parsers, which are the two components that read input the user did not author. Noted as a candidate rather than claimed.",
"dynamic_analysis_unsafe_status": "N/A",
"dynamic_analysis_unsafe_justification": "C# is memory-safe and the project contains no unsafe blocks and no native code of its own.",
"dynamic_analysis_enable_assertions_status": "Met",
"dynamic_analysis_enable_assertions_justification": "Debug builds enable assertions, and the roughly 1,100-method test suite runs with them enabled.",
"dynamic_analysis_fixed_status": "N/A",
"dynamic_analysis_fixed_justification": "No dynamic analysis is run, so it has produced no findings to fix."
}