Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (31 loc) · 1014 Bytes

CONTRIBUTING.md

File metadata and controls

44 lines (31 loc) · 1014 Bytes
Raw

Contributing

Thanks for your interest in contributing to DynamicFileBinder.

Development Setup

  1. Clone with submodules:
    • git clone --recurse-submodules
  2. Bootstrap vcpkg:
    • .\vcpkg\bootstrap-vcpkg.bat
  3. Configure and build:
    • cmake --preset vs-debug-vcpkg
    • cmake --build --preset build-debug
  4. Run tests:
    • ctest --preset test-debug

Branching and Commits

  • Branch from develop.
  • Keep commits focused and atomic.
  • Use descriptive commit messages.

Pull Requests

  • Describe the problem and the solution.
  • Link related issues.
  • Include test evidence.
  • Update docs when behavior changes.

Quality Requirements

  • New logic should include tests.
  • Do not break existing CTest coverage.
  • Preserve data safety and explicit error signaling.

Coding Guidelines

  • Use C++17.
  • Keep platform-specific branches minimal and explicit.
  • Favor clear error codes/messages over silent fallback.

Security

Do not disclose vulnerabilities publicly. See SECURITY.md.