Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.53 KB

File metadata and controls

37 lines (28 loc) · 1.53 KB

Contributing to BSTVC

Thank you for helping improve BSTVC. Contributions may include reproducible bug reports, documentation corrections, worked examples, tests, scientific validation, or code changes.

Before contributing

  1. Search the issue tracker for an existing report or proposal.
  2. Open an issue before making a substantial change so that its scientific scope, expected behavior, and compatibility implications can be discussed.
  3. Do not include confidential, identifiable, proprietary, or otherwise restricted data in issues, examples, tests, or pull requests.

Bug reports

A useful bug report should include:

  • the smallest reproducible example;
  • the expected and observed behavior;
  • the BSTVC, R, INLA, and operating-system versions;
  • relevant warnings or error messages; and
  • synthetic or openly shareable data whenever data are required.

Code and documentation contributions

  • Keep each pull request focused on one clearly described change.
  • Preserve backward compatibility unless a breaking change has been discussed.
  • Add or update documentation and examples when user-facing behavior changes.
  • Add suitable tests for corrected or newly introduced behavior.
  • Describe the scientific rationale for changes that affect model specification, inference, diagnostics, or interpretation.
  • Confirm that examples and checks complete successfully before submission.

By participating in this project, contributors agree to follow the Code of Conduct.