Skip to contents

Contributing to iddoverse

Source: CONTRIBUTING.md

Thank you for your interest in contributing to iddoverse.

iddoverse supports infectious disease researchers by making it easier to work with data from the IDDO data repository. We welcome contributions that improve the package, fix problems, strengthen documentation, or help researchers use the tools more effectively.

We aim to keep the project open, clear, and useful for the global research community. Whether you are fixing a typo, suggesting a new feature, or contributing code, we appreciate your help.

Before you start

Please:

  • read the existing documentation and open issues before you begin
  • check whether someone is already working on the same problem
  • open an issue before starting major changes
  • keep pull requests focused on one change where possible

If you are unsure where to start, get in touch through GitHub Issues.

Ways to contribute

You can contribute in several ways.

Report bugs

Please open a GitHub Issue if you find:

  • errors or unexpected behaviour
  • problems with documentation
  • installation issues
  • broken examples or workflows

When reporting a bug, include:

  • what you expected to happen
  • what happened instead
  • a reproducible example
  • your operating system
  • your R version
  • package versions where relevant

Clear examples help us fix problems quickly.

Suggest improvements

We welcome ideas that help researchers use iddoverse more effectively.

Examples include:

  • new features
  • better workflows
  • improved documentation
  • performance improvements
  • accessibility improvements

Please explain:

  • the problem you want to solve
  • why the change would help users
  • any suggested implementation details

Contribute code

We welcome pull requests for:

  • bug fixes
  • new features
  • tests
  • documentation updates
  • performance improvements

Please keep changes as small and focused as possible.

Pull requests

Before submitting

Please make sure that you have:

  • added or updated tests
  • updated documentation where needed
  • run package checks
  • checked that examples work

When you open a pull request:

  • Describe the change clearly
  • Link related issues where relevant
  • Explain any important design decisions

A member of our team will review your contribution and may suggest changes before merging.

We aim to review pull requests as quickly as possible, but response times may vary depending on team capacity.

Licensing

By contributing to iddoverse, you agree that your contributions will be released under the project licence.

Code of conduct

We expect contributors to:

  • treat others with respect
  • give constructive feedback
  • support an inclusive research community

We do not tolerate harassment, discrimination, or abusive behaviour.

We welcome contributions from researchers, developers, analysts, and the wider global health community.