Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (25 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 1.38 KB

Contributing to XZDBfunction

Thank you for helping improve XZDBfunction. Contributions can include bug reports, documentation improvements, example datasets, tests, and code changes.

Reporting problems

Please open an issue at:

https://github.com/ScottCalcalas/XZDBfunction/issues

Include your operating system, R version, package version, the command you ran, and the smallest dataset or screenshot needed to reproduce the problem. Do not upload private or protected research data to a public issue.

Asking for support

For usage questions, start with the README and the examples copied by xzdb.help(). If the behavior still seems unclear or broken, open a GitHub issue so the answer can help future users too.

Development workflow

  1. Fork the repository or create a branch.
  2. Make a focused change with documentation or tests when practical.
  3. Run R CMD check --no-manual before opening a pull request.
  4. Describe the user-facing change and any remaining limitations.

Data and privacy

The package is often used with laboratory datasets. Please use synthetic, public, or appropriately de-identified data in issues, examples, and tests.

Authorship

Contributions are acknowledged through the public git history. Substantial scientific, design, documentation, or code contributions may also be discussed for release notes or manuscript authorship, consistent with journal policies.