Skip to contents

Contributing guide

Source: .github/CONTRIBUTING.md

Your contribution is very welcome! You can help to improve healthiar for everyone by:

  • making a questions or comments
  • reporting a bug,
  • requesting a feature or
  • providing code.

See below how to engage, ensuring a smooth and transparent process.

Making questions or comments

Do you have a question about how to use healthiar or want to share feedback? Follow these steps:

  1. Check existing discussions in GitHub Issues to avoid duplicates.

  2. Open a new GitHub issue, if no issue with the same topic, including

  • a clear description of your question / comment and
  • relevant code or context, if possible.

And remember: There are no stupid questions! Even if you think your question is simple, others may benefit from the answer.

Reporting a bug

Hopefully, you do not find any ;-) but if you do, please:

  1. Check existing issues in GitHub Issues to avoid duplicates.

  2. Open a new issue including

    • a minimal reproducible example (code + data to recreate the issue),
    • your R version, OS, and package version (call sessionInfo() in the console) and
    • a description of the expected vs. actual behavior.

Requesting a new feature

Did you have a brilliant idea for a new feature?

  1. Check existing issues in GitHub Issues to avoid duplicates.

  2. Open a new issue including

    • an clear explanation of the use case and benefits of the feature.
    • a mock-up or example, if possible.

Providing code

Wow. You are becoming a pro-contributor!

Before you start

  1. Check existing issues in GitHub Issues to avoid duplicates.
  2. Open a new issue and discuss your idea to agree with the authors/maintainers before writing code.
  3. Create a branch linked to the issue (e.g., 123-issue-name) by clicking on Create branch for this issue or link a pull request on the right panel of the Github issue.

Submitting Changes

  1. Make your changes in your branch:
    • Code following the tidyverse style guide.
    • Add tests for new functionality (see tests/).
    • Update documentation (function description or vignettes).
  2. Commit your changes:
    • Provide self-explaining commit names.
    • Keep commits atomic (one logical change per commit).
  3. Push to your branch and open a pull request to the main branch:
    • Wait until a your pull request is reviewed
    • Enjoy life!

Pull Request Review Process

  • Authors/maintainers will review your pull request and may request you changes.
  • Once approved, authors/maintainers will merge your pull request.
  • The review will be addressed as soon as possible, but some patience from your side might be needed.
  • Be aware that only pull requests approved by the authors/maintainers will be merged.

Examples

Acknowledgment of contributors

All contributions to healthiar are greatly appreciated!

  • If you committed a change, this will be reflected in the Github contributors list.
  • If you provided a substantial piece of code (or documentation), you will be recognized in the list of authors of healthiar as contributors (see DESCRIPTION file).

Code of Conduct

By contributing to healthiar, you agree to abide by our code of conduct. Be respectful and inclusive!