trevon/yams
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 2
yams/CONTRIBUTING.md

2.2 KiB
Raw Permalink Blame History

Contributing to YAMS

Thanks for your interest in contributing!

Bug reports and features

  • Tracker: SourceHut tickets (GitHub Issues will be disabled once SourceHut is stable).
  • Filing URL: https://sr.ht/~trvon/yams/trackers
  • Use the ticket template in TICKET_TEMPLATE.md for bug reports and feature requests.
  • Please include: version/commit, platform, repro steps, expected/actual behavior, logs. For security issues, see SECURITY.md.

Development workflow

  • Toolchain: Meson + Conan 2 (primary), Ninja; CMake presets available; C++20.
  • Quick loop (Debug): 
    conan install . -of build/debug -s build_type=Debug -b missing
meson setup build/debug \
  --prefix /usr/local \
  --native-file build/debug/build/Debug/generators/conan_meson_native.ini
meson compile -C build/debug
meson test -C build/debug
  • CMake alternative (optional):
    • Build: cmake --preset yams-release && cmake --build --preset yams-release
    • Tests: ctest --preset yams-release (or ctest --test-dir build/yams-release)
  • GCC flow: see docs/BUILD-GCC.md.
  • Full build guide: see docs/developer/build_system.md.
  • For CI/test speed and stability: export YAMS_DISABLE_MODEL_PRELOAD=1

Style and lint

  • C/C++ formatting: clang-format (see .clang-format). Use our pre-commit hook.
  • Optional: clang-tidy (enable via YAMS_LINT_TIDY=1 in the pre-commit hook).

Git hooks

  • Repo-local hooks live under .githooks/. Enable once: git config core.hooksPath .githooks
  • Pre-commit runs clang-format on staged C/C++ files and can run additional lint.

Commit messages

  • Use concise subject lines; add body with rationale and context when needed.
  • Reference tickets (e.g., sr.ht#123) when relevant.

Security

  • Please don’t open public tickets for vulnerabilities. See SECURITY.md.

Code of Conduct

  • We follow the Contributor Covenant. See CODE_OF_CONDUCT.md.

Governance and Process

  • Please review GOVERNANCE.md for roles, decision process, and releases.
  • Material changes require an RFC (docs/rfcs) and, once accepted, an ADR (docs/adrs).
  • All commits must include DCO sign-off: add a line Signed-off-by: Your Name <you@example.com> to your commit message.
  • CODEOWNERS reviews are required; see .github/CODEOWNERS.