Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
85 lines (66 loc) · 3.6 KB

CONTRIBUTING.md

File metadata and controls

85 lines (66 loc) · 3.6 KB
Raw

Bridge contributor guide

Code of conduct

Follow CODE_OF_CONDUCT.md. Keep discussions constructive, technical, and free of private customer or contributor data.

Contribution license

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Bridge is provided under the Apache License, Version 2.0, without additional terms or conditions. Mark material that is not a contribution conspicuously as Not a Contribution.

Only submit work that you have the right to license. Identify third-party material in the pull request and preserve all applicable copyright, attribution, and license notices. Update NOTICE when a required attribution is introduced.

Development setup

Bridge supports development on Windows and macOS. Install a supported Node.js 22 or 24 release, Corepack, the Rust toolchain selected by rust-toolchain.toml, and the Tauri prerequisites for the host operating system. The bundled SQLCipher/OpenSSL build also requires Perl 5 with Locale::Maketext::Simple; on Windows, use a complete distribution such as Strawberry Perl and set OPENSSL_SRC_PERL if an incomplete Perl appears first on PATH. SQLCipher binding generation also requires LLVM/libclang; set LIBCLANG_PATH to the directory containing libclang.dll when it is not discoverable automatically. Then run from any local clone:

corepack pnpm install --frozen-lockfile
corepack pnpm run build
corepack pnpm run cargo:check
corepack pnpm run tauri:dev

Run corepack pnpm run tauri:build on each native target host when validating packaging. Do not treat a Windows build as macOS evidence or the reverse.

Branching

  • Use short-lived branches from master.
  • Use feat/ for features, fix/ for defects, refactor/ for refactors, chore/ for infrastructure or docs, and rectify/ for regressions.
  • Use an imperative commit subject no longer than 72 characters.

All changes go through a pull request. Follow docs/rectify-guidelines.md for regressions. Potential vulnerabilities and credential/data leaks must use the private flow in SECURITY.md; do not open a public issue or PR until coordinated disclosure is safe.

Pull-request requirements

Every pull request must include:

  • a functional summary and linked issue when applicable
  • exact test or reproduction commands and their results
  • a link to at least one completed item in review-checklist.md
  • migration compatibility and rollback notes for existing workflows
  • security impact notes for DSC, Tally, credential, endpoint, or customer-data changes
  • native Windows and macOS evidence when the change can be platform-sensitive

Never paste raw production logs. Redact or replace names, email addresses, company and tax identifiers, financial data, document contents, certificate details, PINs, tokens, usernames, and absolute local paths.

Issue and triage requirements

  • Use the bug or feature template in .github/ISSUE_TEMPLATE.
  • Assign exactly one area label: area:tally, area:dsc, area:documents, area:infra, or area:security.
  • Assign a severity label for bugs: severity:p1 through severity:p4.
  • Use type:rectify for a regression introduced by a merged change and link the introducing pull request.
  • Include the operating system and Bridge version for workflow bugs. Add Tally and DSC vendor versions only when relevant and safe to disclose.

Use synthetic reproduction data. Do not attach customer files, certificate output, secrets, or machine-specific paths.