Skip to contents

Contribution Guidelines

Source: .github/CONTRIBUTING.md

🙏 Thank you for taking the time to contribute!

Your input is deeply valued, whether an issue, a pull request, or even feedback, regardless of size, content or scope.

Table of contents

🗃 License

📜 Issues

🚩 Pull requests

👗 Style guide

🏆 Recognition model

❓ Questions

License

All your contributions will be covered by this project’s license.

Issues

We use GitHub to track issues, feature requests, and bugs. Before submitting a new issue, please check if the issue has already been reported. If the issue already exists, please upvote the existing issue 👍. If you are reporting a bug, please try to be as specific as possible in describing it and provide a minimal reproducible example (if possible).

For new feature requests, please elaborate on the context and the benefit the feature will have for users, developers, or other relevant personas.

Proposing changes to the code

This repository uses the Github flow model for collaboration. To submit a pull request:

  1. Create a branch.

    Please see the branch naming convention below. If you don’t have write access to this repository, please fork it.

  2. Make changes.

    Make sure your code:

    • passes all checks imposed by GitHub Actions
    • is well documented
    • is well tested with unit tests sufficiently covering the changes introduced

  3. Create a pull request (PR).

    In the pull request description, please link the relevant issue (if any), provide a detailed description of the change, and include any assumptions.

  4. Address review comments, if any (and let the reviewer know).

  5. Receive an approval.

    Merge your PR if you have write access. Otherwise, the reviewer will merge the PR on your behalf.

  6. Pat yourself on the back.

    Congratulations! 🎉 You are now an official contributor to this project! We are grateful for your contribution.

Style guide

This repository follows the standard tidyverse style guide and uses lintr for lint checks. Customized lint configurations are available in this repository’s .lintr file.

Updating stan models

The stan models contained in inst/stan are not automatically updated to avoid taking a dependency on the rstantools package.
After modifying or adding new models, run

rstantools::rstan_config()

and silence R/stanmodels.R via capture.output().

Recognition model

There is currently no formal recognition model in place. If you expect recognition of a certain kind for a contribution, make sure to clarify with the package maintainer in advance.

Questions

If you have further questions regarding the contribution guidelines, please contact the package/repository maintainer.